GraphUserGroupTraverseGSuiteResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphUserGroupTraverseLdapServerResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphUserGroupTraverseOffice365Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphUserGroupTraverseRadiusServerResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphUserGroupTraverseSystemGroupResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphUserGroupTraverseSystemResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphUserMemberOfResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphUserTraverseActiveDirectoryResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphUserTraverseApplicationResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphUserTraverseDirectoryResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphUserTraverseGSuiteResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphUserTraverseLdapServerResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphUserTraverseOffice365Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphUserTraverseRadiusServerResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphUserTraverseSystemGroupResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphUserTraverseSystemResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
Group
{
"type": "object",
"title": "Group",
"properties": {
"id": {
"type": "string",
"description": "ObjectId uniquely identifying a Group."
},
"name": {
"type": "string",
"description": "Display name of a Group."
},
"type": {
"$ref": "#/components/schemas/GroupType"
},
"email": {
"type": "string",
"description": "E-mail address associated with a Group"
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
},
"description": {
"type": "string",
"description": "Description of a Group"
}
}
}
GroupAttributes-UserGroup
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/GraphAttributes"
},
{
"$ref": "#/components/schemas/GraphAttribute-Sudo"
},
{
"$ref": "#/components/schemas/GraphAttribute-LdapGroups"
},
{
"$ref": "#/components/schemas/GraphAttribute-PosixGroups"
},
{
"$ref": "#/components/schemas/GraphAttribute-Radius"
},
{
"$ref": "#/components/schemas/GraphAttribute-SambaEnabled"
}
],
"title": "GroupAttributes (UserGroup)",
"nullable": true,
"description": "The graph attributes for a UserGroup."
}
GroupMembershipMethodType
{
"enum": [
"NOTSET",
"STATIC",
"DYNAMIC_REVIEW_REQUIRED",
"DYNAMIC_AUTOMATED"
],
"type": "string",
"title": "GroupMembershipMethodType",
"description": "The type of membership method for this group. Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED.\n\nNote DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices).\n\nUse caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets."
}
GroupPwm
{
"type": "object",
"required": [
"id",
"name",
"accessLevelId",
"accessLevelName"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"example": "group name"
},
"externalId": {
"type": "string"
},
"usersCount": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string",
"example": "finance group"
},
"accessLevelId": {
"type": "string",
"format": "uuid"
},
"accessLevelName": {
"type": "string",
"example": "folder manager"
}
}
}
GroupType
{
"enum": [
"policy_group",
"system_group",
"user_group"
],
"type": "string",
"title": "GroupType",
"description": "The group type."
}
Groups
{
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"example": "group name"
}
}
}
}
GroupsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
}
}
GsuitesListImportJumpcloudUsersResponse
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
},
"nextPageToken": {
"type": "string"
}
}
}
GsuitesListImportUsersResponse
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"givenName": {
"type": "string"
},
"familyName": {
"type": "string"
},
"primaryEmail": {
"type": "string"
},
"thumbnailPhotoUrl": {
"type": "string"
}
}
}
},
"nextPageToken": {
"type": "string"
}
}
}
IPList
{
"type": "object",
"title": "IPList",
"properties": {
"id": {
"type": "string"
},
"ips": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
IPListRequest
{
"type": "object",
"title": "IPListRequest",
"properties": {
"ips": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
ImportOperation
{
"enum": [
"users.create",
"users.update"
],
"type": "string",
"title": "ImportOperation",
"description": "The operation to be executed on import"
}
ImportUsersRequest
{
"type": "object",
"title": "ImportUsersRequest",
"properties": {
"operations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportOperation"
},
"default": [
"users.create",
"users.update"
],
"description": "Operations to be performed on the user list returned from the application"
},
"queryString": {
"type": "string",
"default": "",
"description": "Query string to filter and sort the user list returned from the application. The supported filtering and sorting varies by application. If no value is sent, all users are returned.\n**Example:** \"location=Chicago&department=IT\"Query string used to retrieve users from service"
},
"allowUserReactivation": {
"type": "boolean",
"default": true,
"description": "A boolean value to allow the reactivation of suspended users"
}
}
}
InstallActionType
{
"enum": [
"DOWNLOAD_ONLY",
"INSTALL_LATER",
"INSTALL_ASAP",
"INSTALL_FORCE_RESTART"
],
"type": "string"
}
Integration
{
"type": "object",
"title": "Integration",
"properties": {
"type": {
"$ref": "#/components/schemas/IntegrationType"
},
"integrationId": {
"type": "string",
"description": "Unique identifier for this integration"
}
},
"description": "An integration."
}
IntegrationSyncError
{
"type": "object",
"required": [
"orgId",
"timestamp",
"errorType",
"message"
],
"properties": {
"orgId": {
"type": "string"
},
"message": {
"type": "string"
},
"errorType": {
"type": "string"
},
"timestamp": {
"type": "string"
}
},
"description": "Integration sync error details"
}
IntegrationSyncErrorResp
{
"type": "object",
"required": [
"records",
"totalCount"
],
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationSyncError"
}
},
"totalCount": {
"type": "integer"
}
},
"description": "Response for retrieving integrations sync errors"
}
IntegrationType
{
"enum": [
"autotask",
"connectwise",
"syncro"
],
"type": "string",
"title": "IntegrationType",
"description": "The type of integration."
}
IntegrationsResponse
{
"type": "object",
"title": "IntegrationsResponse",
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Integration"
}
},
"totalCount": {
"type": "integer"
}
},
"description": "Response for retrieving integrations."
}
IplistsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/IPList"
}
}
LdapGroup
{
"type": "object",
"title": "Ldap Group",
"properties": {
"name": {
"type": "string"
}
},
"description": "An LDAP group object."
}
LdapServerAction
{
"enum": [
"disable",
"remove"
],
"type": "string",
"title": "LDAP Server Action"
}
LdapserversListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ldap-server"
}
}
LdapserversPatch400Response
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
LdapserversPatchRequest
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"userLockoutAction": {
"$ref": "#/components/schemas/LdapServerAction"
},
"userPasswordExpirationAction": {
"$ref": "#/components/schemas/LdapServerAction"
}
}
}
LdapserversPatchResponse
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"userLockoutAction": {
"$ref": "#/components/schemas/LdapServerAction"
},
"userPasswordExpirationAction": {
"$ref": "#/components/schemas/LdapServerAction"
}
}
}
LdapserversSambaDomainsDeleteResponse
{
"type": "string"
}
LdapserversSambaDomainsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/samba-domain"
}
}
LogosGet200Response
{
"type": "string",
"format": "binary"
}
LogosGetResponse
{
"type": "string",
"format": "binary"
}
MemberQuery
{
"allOf": [
{
"$ref": "#/components/schemas/Query"
},
{
"type": "object",
"title": "MemberQuery",
"properties": {
"filters": {
"type": "array",
"items": {}
}
},
"x-internal": false
}
],
"x-examples": {
"example-1": {
"filters": [
{
"field": "string",
"value": "string",
"operator": "eq"
}
],
"queryType": "MemberQuery"
}
},
"description": "Query using a sequence of field filters."
}
MemberSuggestion
{
"properties": {
"op": {
"enum": [
"add",
"remove"
],
"type": "string",
"description": "How to modify group membership."
},
"object": {
"$ref": "#/components/schemas/GraphObject"
}
}
}
MemberSuggestionsPostResult
{
"properties": {
"suggestions_found": {
"type": "array",
"items": {
"type": "string"
}
},
"suggestions_not_found": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
OSRestriction
{
"type": "object",
"example": {
"with-apple-restrictions": {
"osName": "iPadOS",
"earliestVersion": "14.1",
"appleRestrictions": {
"requiresSupervision": false,
"supportedEnrollmentTypes": [
"automated",
"device",
"user"
]
},
"deprecatedVersion": "16.2"
}
},
"properties": {
"osName": {
"type": "string",
"description": "The name of the OS in which this restriction applies"
},
"earliestVersion": {
"type": "string",
"description": "The earliest version of the OS in which the policy can be applied"
},
"appleRestrictions": {
"type": "object",
"properties": {
"requiresSupervision": {
"type": "boolean",
"description": "Boolean representing if the policy requires the Apple devices to be MDM supervised"
},
"supportedEnrollmentTypes": {
"type": "array",
"items": {
"enum": [
"automated",
"device",
"user"
],
"type": "string"
},
"description": "The supported Apple enrollment types for this policy"
}
},
"description": "The Apple specific restricitons for this policy, if there are any"
},
"deprecatedVersion": {
"type": "string",
"description": "The version of the OS in which the policy was deprecated"
},
"supportedEnrollmentTypes": {
"type": "array",
"items": {
"enum": [
"automated",
"device",
"user"
],
"type": "string"
},
"description": "This field is deprecated and will be ignored. Use appleRestrictions.supportedEnrollmentTypes instead",
"x-deprecated": true
}
},
"description": "Contains OS properties to restrict the application of policies to devices based on the device's OS"
}