openapi.city
Sign in

JumpCloud API

Directory platform for IT management

docs.jumpcloud.com/api ↗
Version
2.0
OpenAPI
3.0.0
Endpoints
416
Schemas
669
82
Quality
Updated
3 days ago
Identity identity directory it-management
Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://console.jumpcloud.com/api/v2

Endpoints

Clear filters
GET POST PUT PATCH DELETE

Activedirectory 2 endpoints

DELETE /activedirectories/{activedirectory_id}/agents/{agent_id}

This endpoint deletes an Active Directory agent.

Sample Request

curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}'
operationId: activedirectories_agentsDelete

Parameters

Name In Required Type Description
activedirectory_id path required string —
agent_id path required string —
x-org-id header optional string

Organization identifier that can be obtained from console settings.

Responses

204 —
DELETE /activedirectories/{activedirectory_id}/agents/{agent_id}
DELETE /activedirectories/{id}

This endpoint allows you to delete an Active Directory Instance.

Sample Request

curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}'
operationId: activedirectories_delete

Parameters

Name In Required Type Description
id path required string

ObjectID of this Active Directory instance.
x-org-id header optional string

Organization identifier that can be obtained from console settings.

Responses

200

OK
DELETE /activedirectories/{id}

Administrators 1 endpoints

DELETE /administrators/{administrator_id}/organizationlinks/{id}

This endpoint removes the association link between an Administrator and an Organization.

operationId: administratorOrganizations_removeByAdministrator

Parameters

Name In Required Type Description
administrator_id path required string —
id path required string —

Responses

204

No Content
400 —
401 —
403 —
404 —
500 —
DELETE /administrators/{administrator_id}/organizationlinks/{id}

Applemdm 2 endpoints

DELETE /applemdms/{apple_mdm_id}/devices/{device_id}

Remove a single Apple MDM device from MDM enrollment.

Sample Request

  curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \
  -H 'accept: application/json' \
  -H 'x-api-key: {API_KEY}'
operationId: applemdms_deletedevice

Parameters

Name In Required Type Description
x-org-id header optional string

Organization identifier that can be obtained from console settings.
apple_mdm_id path required string —
device_id path required string —

Responses

200

OK
DELETE /applemdms/{apple_mdm_id}/devices/{device_id}
DELETE /applemdms/{id}

Removes an Apple MDM configuration.

Warning: This is a destructive operation and will remove your Apple Push Certificates. We will no longer be able to manage your devices and the only recovery option is to re-register all devices into MDM.

Sample Request

curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{id} \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}'
operationId: applemdms_delete

Parameters

Name In Required Type Description
id path required string —
x-org-id header optional string

Organization identifier that can be obtained from console settings.

Responses

200 —
400 —
401 —
403 —
404 —
409 —
500 —
DELETE /applemdms/{id}

Applications 1 endpoints

DELETE /applications/{application_id}/logo

Deletes the specified image from an application

operationId: applications_deleteLogo

Parameters

Name In Required Type Description
application_id path required string —
x-org-id header optional string

Organization identifier that can be obtained from console settings.

Responses

204

NO_CONTENT
400 —
401 —
403 —
404 —
409 —
500 —
DELETE /applications/{application_id}/logo

Authenticationpolicies 1 endpoints

DELETE /authn/policies/{id}

Delete the specified authentication policy.

Sample Request

curl -X DELETE https://console.jumpcloud.com/api/v2/authn/policies/{id} \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}'
operationId: authnpolicies_delete

Parameters

Name In Required Type Description
id path required string

Unique identifier of the authentication policy
x-org-id header optional string

Organization identifier that can be obtained from console settings.

Responses

200

OK
400 —
401 —
403 —
404 —
409 —
500 —
DELETE /authn/policies/{id}

Bulkjobrequests 1 endpoints

DELETE /bulk/userstates/{id}

This endpoint deletes a scheduled statechange job.

Sample Request

curl -X DELETE "https://console.jumpcloud.com/api/v2/bulk/userstates/{ScheduledJob_ID}" \
  -H 'x-api-key: {API_KEY}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'
operationId: bulk_userStatesDelete

Parameters

Name In Required Type Description
id path required string

Unique identifier of the scheduled statechange job.
x-org-id header optional string

Organization identifier that can be obtained from console settings.

Responses

204

No Content
400 —
401 —
403 —
404 —
409 —
500 —
DELETE /bulk/userstates/{id}

Commands 1 endpoints

DELETE /commandqueue/{workflow_instance_id}

This endpoint allows all queued commands for one workflow instance to be canceled.

Sample Request

 curl -X DELETE https://console.jumpcloud.com/api/v2/commandqueue/{workflow_instance_id} \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}'
operationId: commands_cancelQueuedCommandsByWorkflowInstanceId

Parameters

Name In Required Type Description
workflow_instance_id path required string

Workflow instance Id of the queued commands to cancel.
x-org-id header optional string

Organization identifier that can be obtained from console settings.

Responses

204

OK
400 —
401 —
403 —
404 —
409 —
500 —
DELETE /commandqueue/{workflow_instance_id}

Customemails 1 endpoints

DELETE /customemails/{custom_email_type}

Delete the custom email configuration for the specified custom email type

operationId: customEmails_destroy

Parameters

Name In Required Type Description
custom_email_type path required string —
x-org-id header optional string

Organization identifier that can be obtained from console settings.

Responses

204

No Content
400 —
401 —
403 —
404 —
409 —
500 —
DELETE /customemails/{custom_email_type}

Duo 2 endpoints

DELETE /duo/accounts/{account_id}/applications/{application_id}

Deletes the specified Duo application, an error will be returned if the application is used in a protected resource.

Sample Request

  curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}''
operationId: duo_applicationDelete

Parameters

Name In Required Type Description
account_id path required string —
application_id path required string —
x-org-id header optional string

Organization identifier that can be obtained from console settings.

Responses

200 —
400 —
401 —
403 —
404 —
409 —
500 —
DELETE /duo/accounts/{account_id}/applications/{application_id}
DELETE /duo/accounts/{id}

Removes the specified Duo account, an error will be returned if the account has some Duo application used in a protected resource.

Sample Request

curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{id} \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}'
operationId: duo_accountDelete

Parameters

Name In Required Type Description
id path required string

ObjectID of the Duo Account
x-org-id header optional string

Organization identifier that can be obtained from console settings.

Responses

200 —
400 —
401 —
403 —
404 —
409 —
500 —
DELETE /duo/accounts/{id}

Gsuite 3 endpoints

DELETE /gsuites/{gsuite_id}/domains/{domainId}

Delete a domain from a specific Google Workspace directory sync integration instance.

Sample Request

curl -X DELETE https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/domains/{domainId} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
operationId: GSuite_deleteDomain

Parameters

Name In Required Type Description
gsuite_id path required string

Id for the specific Google Workspace directory sync integration instance.
domainId path required string

Id for the domain.

Responses

default

An unexpected error response.
200

OK
401

Unauthorized
403

Forbidden
404

Not Found
500

Internal Server Error
DELETE /gsuites/{gsuite_id}/domains/{domainId}
DELETE /gsuites/{gsuite_id}/import/schedules/{scheduledJobId}

Endpoint to delete the specified scheduled job from gapps and kala.

operationId: GSuite_deleteScheduledJob

Parameters

Name In Required Type Description
gsuite_id path required string

ObjectID of the Google Workspace integration
scheduledJobId path required string

ObjectID of the Scheduled Job

Responses

default

An unexpected error response.
200

A successful response.
204

No Content
401

Unauthorized
403

Forbidden
404

Not Found
500

Internal Server Error
DELETE /gsuites/{gsuite_id}/import/schedules/{scheduledJobId}
DELETE /gsuites/{gsuite_id}/translationrules/{id}

This endpoint allows you to delete a translation rule for a specific G Suite instance. These rules specify how JumpCloud attributes translate to G Suite Admin SDK attributes.

Sample Request

curl -X DELETE https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
operationId: translationRules_gSuiteDelete

Parameters

Name In Required Type Description
gsuite_id path required string —
id path required string —

Responses

204 —
DELETE /gsuites/{gsuite_id}/translationrules/{id}

Googleemm 2 endpoints

DELETE /google-emm/enterprises/{enterpriseId}

Removes a Google EMM enterprise.

Warning: This is a destructive operation and will remove all data associated with Google EMM enterprise from JumpCloud including devices and applications associated with the given enterprise.

Sample Request

curl -X DELETE https://console.jumpcloud.com/api/v2/google-emm/devices/{enterpriseId} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
operationId: Enterprises_DeleteEnterprise

Parameters

Name In Required Type Description
enterpriseId path required string —

Responses

200

A successful response.
DELETE /google-emm/enterprises/{enterpriseId}
DELETE /google-emm/enterprises/{enterpriseId}/enrollment-tokens/{tokenId}

Removes an Enrollment token for a given enterprise and token id.

Sample Request

curl -X DELETE https://console.jumpcloud.com/api/v2/enterprises/{enterprise_id}/enrollment-tokens/{token_id} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
operationId: EnrollmentTokens_DeleteEnrollmentToken

Parameters

Name In Required Type Description
enterpriseId path required string —
tokenId path required string —

Responses

200

A successful response.
DELETE /google-emm/enterprises/{enterpriseId}/enrollment-tokens/{tokenId}

Iplists 1 endpoints

DELETE /iplists/{id}

Delete a specific IP list.

Sample Request

curl -X DELETE https://console.jumpcloud.com/api/v2/iplists/{id} \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}'
operationId: iplists_delete

Parameters

Name In Required Type Description
id path required string —
x-org-id header optional string

Organization identifier that can be obtained from console settings.

Responses

200

OK
400 —
401 —
403 —
404 —
409 —
500 —
DELETE /iplists/{id}

Office365 2 endpoints

DELETE /office365s/{office365_id}/domains/{domain_id}

Delete a domain from a specific M365/Azure AD directory sync integration instance.

Sample Request

curl -X POST https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/domains/{DOMAIN_ID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
operationId: Domains_Delete

Parameters

Name In Required Type Description
office365_id path required string

Id for the specific M365/Azure AD directory sync integration instance.
domain_id path required string

ObjectID of the domain to be deleted.

Responses

default

An unexpected error response.
200

OK
401 —
403 —
404 —
500 —
DELETE /office365s/{office365_id}/domains/{domain_id}
DELETE /office365s/{office365_id}/translationrules/{id}

This endpoint allows you to delete a translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to Microsoft Graph attributes.

Sample Request

curl -X DELETE https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
operationId: translationRules_office365Delete

Parameters

Name In Required Type Description
office365_id path required string —
id path required string —

Responses

204 —
DELETE /office365s/{office365_id}/translationrules/{id}

Policies 1 endpoints

DELETE /policies/{id}

This endpoint allows you to delete a policy.

Sample Request

curl -X DELETE https://console.jumpcloud.com/api/v2/policies/5a837ecd232e110d4291e6b9 \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
operationId: policies_delete

Parameters

Name In Required Type Description
id path required string

ObjectID of the Policy object.
x-org-id header optional string

Organization identifier that can be obtained from console settings.

Responses

204

No Content
DELETE /policies/{id}

Policygroups 1 endpoints

DELETE /policygroups/{id}

This endpoint allows you to delete a Policy Group.

Sample Request

curl -X DELETE https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
operationId: PolicyGroups_deleteGroup

Parameters

Name In Required Type Description
id path required string

ObjectID of the Policy Group.
x-org-id header optional string

Organization identifier that can be obtained from console settings.

Responses

200

OK
204

No Content
DELETE /policygroups/{id}

Providers 5 endpoints

DELETE /providers/{provider_id}/administrators/{id}

This endpoint removes an Administrator associated with the Provider. You must be associated with the provider to use this route.

operationId: providers_removeAdministrator

Parameters

Name In Required Type Description
provider_id path required string —
id path required string —

Responses

204

No Content
400 —
401 —
403 —
404 —
500 —
DELETE /providers/{provider_id}/administrators/{id}
DELETE /integrations/autotask/{UUID}

Removes a Autotask integration.

operationId: autotask_deleteConfiguration

Parameters

Name In Required Type Description
UUID path required string —

Responses

204

No Content
400 —
401 —
403 —
404 —
500 —
DELETE /integrations/autotask/{UUID}
DELETE /integrations/connectwise/{UUID}

Removes a ConnectWise integration.

operationId: connectwise_deleteConfiguration

Parameters

Name In Required Type Description
UUID path required string —

Responses

204

No Content
400 —
401 —
403 —
404 —
500 —
DELETE /integrations/connectwise/{UUID}
DELETE /integrations/syncro/{UUID}

Removes a Syncro integration.

operationId: syncro_deleteConfiguration

Parameters

Name In Required Type Description
UUID path required string —

Responses

204

No Content
400 —
401 —
403 —
404 —
500 —
DELETE /integrations/syncro/{UUID}
DELETE /providers/{provider_id}/policygrouptemplates/{id}

Deletes a Policy Group Template.

operationId: policyGroupTemplates_delete

Parameters

Name In Required Type Description
provider_id path required string —
id path required string —

Responses

201

NO_CONTENT
400 —
401 —
403 —
404 —
500 —
DELETE /providers/{provider_id}/policygrouptemplates/{id}

Sambadomains 1 endpoints

DELETE /ldapservers/{ldapserver_id}/sambadomains/{id}

This endpoint allows you to delete a samba domain from an LDAP server.

Sample Request
curl -X DELETE https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
operationId: ldapservers_sambaDomainsDelete

Parameters

Name In Required Type Description
ldapserver_id path required string

Unique identifier of the LDAP server.
id path required string

Unique identifier of the samba domain.
x-org-id header optional string

Organization identifier that can be obtained from console settings.

Responses

200 —
204 —
DELETE /ldapservers/{ldapserver_id}/sambadomains/{id}

Softwareapps 1 endpoints

DELETE /softwareapps/{id}

Removes a Software Application configuration.

Warning: This is a destructive operation and will unmanage the application on all affected systems.

Sample Request

curl -X DELETE https://console.jumpcloud.com/api/v2/softwareapps/{id} \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}'
operationId: softwareApps_delete

Parameters

Name In Required Type Description
id path required string —
x-org-id header optional string

Organization identifier that can be obtained from console settings.

Responses

204 —
400 —
401 —
403 —
404 —
409 —
500 —
DELETE /softwareapps/{id}

Systemgroups 1 endpoints

DELETE /systemgroups/{id}

This endpoint allows you to delete a System Group.

Sample Request

curl -X DELETE https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
operationId: SystemGroups_deleteGroup

Parameters

Name In Required Type Description
id path required string

ObjectID of the System Group.
x-org-id header optional string

Organization identifier that can be obtained from console settings.

Responses

200

OK
204

No Content
DELETE /systemgroups/{id}

Usergroups 1 endpoints

DELETE /usergroups/{id}

This endpoint allows you to delete a User Group.

Sample Request

curl -X DELETE https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
operationId: UserGroups_deleteGroup

Parameters

Name In Required Type Description
id path required string

ObjectID of the User Group.
x-org-id header optional string

Organization identifier that can be obtained from console settings.

Responses

200

OK
204

No Content
DELETE /usergroups/{id}

Users 1 endpoints

DELETE /users/{user_id}/pushendpoints/{push_endpoint_id}

This endpoint will delete a push endpoint associated with a user.

operationId: pushEndpoints_delete

Parameters

Name In Required Type Description
user_id path required string —
push_endpoint_id path required string —
x-org-id header optional string

Organization identifier that can be obtained from console settings.

Responses

200

OK
400 —
401 —
403 —
404 —
409 —
500 —
DELETE /users/{user_id}/pushendpoints/{push_endpoint_id}

Workdayimport 1 endpoints

DELETE /workdays/{workday_id}/auth

Removes any and all authorization methods from the workday instance

Sample Request
curl -X DELETE https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
operationId: workdays_deauthorize

Parameters

Name In Required Type Description
workday_id path required string —
x-org-id header optional string

Organization identifier that can be obtained from console settings.

Responses

204 —
DELETE /workdays/{workday_id}/auth
Load more endpoints

Schemas

object ADE 
{
  "type": "object",
  "title": "ADE",
  "properties": {
    "setupOptions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SetupAssistantOption"
      },
      "description": "A list of configured setup options for this enrollment."
    },
    "welcomeScreen": {
      "$ref": "#/components/schemas/DEPWelcomeScreen"
    },
    "setupAssistantOptions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DEPSetupAssistantOption"
      },
      "description": "A Setup Option wrapped as an object",
      "x-deprecated": true
    },
    "enableZeroTouchEnrollment": {
      "type": "boolean",
      "description": "A toggle to determine if ADE registered devices should go through JumpCloud Zero Touch Enrollment."
    },
    "defaultDeviceGroupObjectIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "description": "An array of ObjectIDs identifying the default device groups for this specific type (based on the OS family) of automated device enrollment. Currently, only a single DeviceGroupID is supported."
    }
  }
}
object ADES 
{
  "type": "object",
  "title": "ADES",
  "properties": {
    "ios": {
      "$ref": "#/components/schemas/ADE"
    },
    "macos": {
      "$ref": "#/components/schemas/ADE"
    }
  }
}
object AccessRequestApiRevokeAccessRequestResponse 
{
  "type": "object",
  "example": {},
  "properties": {}
}
object AccessRequestApiUpdateAccessRequestRequest 
{
  "type": "object",
  "properties": {
    "expiry": {
      "type": "string",
      "format": "date-time"
    },
    "remarks": {
      "type": "string"
    },
    "additionalAttributes": {
      "type": "object"
    },
    "organizationObjectId": {
      "type": "string",
      "format": "byte"
    }
  }
}
object AccessRequestApiUpdateAccessRequestResponse 
{
  "type": "object",
  "example": {},
  "properties": {}
}
array ActivedirectoriesAgentsListResponse 
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/active-directory-agent-list"
  }
}
array ActivedirectoriesListResponse 
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/active-directory"
  }
}
object Address 
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "maxLength": 1024
    },
    "poBox": {
      "type": "string",
      "maxLength": 1024
    },
    "region": {
      "type": "string",
      "maxLength": 1024
    },
    "country": {
      "type": "string",
      "maxLength": 1024
    },
    "locality": {
      "type": "string",
      "maxLength": 1024
    },
    "postalCode": {
      "type": "string",
      "maxLength": 1024
    },
    "streetAddress": {
      "type": "string",
      "maxLength": 1024
    },
    "extendedAddress": {
      "type": "string",
      "maxLength": 1024
    }
  }
}
object Administrator 
{
  "type": "object",
  "title": "Administrator",
  "example": {
    "id": "0123456789abcdef01234567",
    "email": "joe@example.com",
    "lastname": "Blough",
    "firstname": "Joe",
    "registered": false,
    "enableMultiFactor": true
  },
  "properties": {
    "id": {
      "type": "string"
    },
    "role": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "lastname": {
      "type": "string"
    },
    "roleName": {
      "type": "string"
    },
    "apiKeySet": {
      "type": "boolean"
    },
    "firstname": {
      "type": "string"
    },
    "suspended": {
      "type": "boolean"
    },
    "registered": {
      "type": "boolean"
    },
    "apiKeyAllowed": {
      "type": "boolean"
    },
    "enableMultiFactor": {
      "type": "boolean"
    },
    "organizationAccessTotal": {
      "type": "number"
    }
  }
}
object AdministratorOrganizationLink 
{
  "type": "object",
  "title": "AdministratorOrganizationLink",
  "example": {
    "organization": "6230a0d26a4e4bc86c6b36f1",
    "administrator": "6230a0c233a6cbea7c470398"
  },
  "properties": {
    "organization": {
      "type": "string",
      "description": "The identifier for an organization"
    },
    "administrator": {
      "type": "string",
      "description": "The identifier for an administrator"
    }
  }
}
object AdministratorOrganizationLinkReq 
{
  "type": "object",
  "title": "AdministratorOrganizationLinkReq",
  "example": {
    "organization": "6230a0d26a4e4bc86c6b36f1"
  },
  "properties": {
    "organization": {
      "type": "string",
      "description": "The identifier for an organization to link this administrator to."
    }
  }
}
array AdministratorOrganizationsListByAdministratorResponse 
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/AdministratorOrganizationLink"
  }
}
array AdministratorOrganizationsListByOrganizationResponse 
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/AdministratorOrganizationLink"
  }
}
object AnyValue 
{
  "description": "Can be any value - string, number, boolean, array or object."
}
object AppleMDM 
{
  "type": "object",
  "title": "AppleMDM",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "ObjectId uniquely identifying an MDM Enrollment,"
    },
    "dep": {
      "$ref": "#/components/schemas/DEP"
    },
    "ades": {
      "$ref": "#/components/schemas/ADES"
    },
    "name": {
      "type": "string",
      "maxLength": 255,
      "description": "A friendly name to identify this enrollment.  Not required to be unique."
    },
    "organization": {
      "type": "string",
      "description": "The identifier for an organization"
    },
    "apnsPushTopic": {
      "type": "string",
      "description": "The push topic assigned to this enrollment by Apple after uploading the Signed CSR plist."
    },
    "apnsCertExpiry": {
      "type": "string",
      "description": "The expiration date and time for the APNS Certificate."
    },
    "depServerTokenState": {
      "enum": [
        "unknown",
        "missing",
        "valid",
        "expired"
      ],
      "type": "string",
      "description": "The state of the dep server token, presence and expiry."
    },
    "defaultSystemGroupID": {
      "type": "string",
      "description": "ObjectId uniquely identifying the MDM default System Group.",
      "x-deprecated": true
    },
    "depAccessTokenExpiry": {
      "type": "string",
      "description": "The expiration date and time for the DEP Access Token. This aligns with the DEP Server Token State."
    },
    "appleCertSerialNumber": {
      "type": "string",
      "description": "The serial number of the Apple signed certificate associated to the Device Manager."
    },
    "appleCertCreatorAppleID": {
      "type": "string",
      "description": "The Apple ID of the admin who created the Apple signed certificate associated to the Device Manager."
    },
    "allowMobileUserEnrollment": {
      "type": "boolean",
      "description": "A toggle to allow mobile device enrollment for an organization."
    },
    "defaultIosUserEnrollmentDeviceGroupID": {
      "type": "string",
      "description": "ObjectId uniquely identifying the MDM default iOS user enrollment device group."
    }
  }
}
object ApplemdmsDevicesClearActivationLock500Response 
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}
object ApplemdmsDevicesClearActivationLockResponse 
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}
object ApplemdmsDevicesOsUpdateStatusResponse 
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}
object ApplemdmsDevicesRefreshActivationLockInformation500Response 
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}
object ApplemdmsDevicesRefreshActivationLockInformationResponse 
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}
object ApplemdmsDevicesScheduleOsUpdateResponse 
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}
object ApplemdmsDeviceserase500Response 
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}
object ApplemdmsDeviceseraseRequest 
{
  "type": "object",
  "properties": {
    "pin": {
      "type": "string",
      "example": "123456",
      "pattern": "^[0-9]{6}$",
      "description": "6-digit PIN, required for MacOS, to erase the device"
    }
  }
}
object ApplemdmsDeviceseraseResponse 
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}
array ApplemdmsDeviceslistResponse 
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/apple-mdm-device"
  }
}
object ApplemdmsDeviceslock500Response 
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}
object ApplemdmsDeviceslockRequest 
{
  "type": "object",
  "properties": {
    "pin": {
      "type": "string",
      "example": "123456",
      "pattern": "^[0-9]{6}$",
      "description": "6-digit PIN, required for MacOS, to lock the device"
    }
  }
}
object ApplemdmsDeviceslockResponse 
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}
object ApplemdmsDevicesrestart500Response 
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}
object ApplemdmsDevicesrestartRequest 
{
  "type": "object",
  "properties": {
    "kextPaths": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The string to pass when doing a restart and performing a RebuildKernelCache."
    }
  }
}
object ApplemdmsDevicesrestartResponse 
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}
object ApplemdmsDevicesshutdown500Response 
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}
object ApplemdmsDevicesshutdownResponse 
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}
array ApplemdmsEnrollmentprofileslistResponse 
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/AppleMDM"
  }
}
array ApplemdmsListResponse 
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/AppleMDM"
  }
}
object ApplemdmsRefreshdepdevices500Response 
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}
object ApplemdmsRefreshdepdevicesResponse 
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}
object ApplicationsGetResponse 
{
  "type": "object",
  "example": {},
  "properties": {}
}
object ApplicationsPostLogoRequest 
{
  "type": "object",
  "properties": {
    "image": {
      "type": "string",
      "format": "binary",
      "description": "The file to upload."
    }
  }
}
array Apps 
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "osId": {
        "type": "integer",
        "format": "int32",
        "example": 1
      },
      "appVersion": {
        "type": "string",
        "example": "1.1.1"
      }
    }
  }
}
object AuthnPolicy 
{
  "type": "object",
  "title": "AuthnPolicy",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string"
    },
    "type": {
      "$ref": "#/components/schemas/AuthnPolicyType"
    },
    "effect": {
      "$ref": "#/components/schemas/AuthnPolicyEffect"
    },
    "targets": {
      "$ref": "#/components/schemas/AuthnPolicyTargets"
    },
    "disabled": {
      "type": "boolean"
    },
    "conditions": {
      "type": "object",
      "description": "Conditions may be added to an authentication policy using the following conditional language:\n\n```\n<conditions> ::= <expression>\n<expression> ::= <deviceEncrypted> | <deviceManaged> | <ipAddressIn> |\n                 <locationIn> | <notExpression> | <allExpression> |\n                 <anyExpression>\n<deviceEncrypted> ::= { \"deviceEncrypted\": <boolean> }\n<deviceManaged> ::= { \"deviceManaged\": <boolean> }\n<ipAddressIn> ::= { \"ipAddressIn\": [ <objectId>, ... ] }\n<locationIn> ::= { \"locationIn\": {\n                     \"countries\": [\n                       <iso_3166_country_code>, ...\n                     ]\n                   }\n                 }\n<notExpression> ::= { \"not\": <expression> }\n<allExpression> ::= { \"all\": [ <expression>, ... ] }\n<anyExpression> ::= { \"any\": [ <expression>, ... ] }\n```\n\nFor example, to add a condition that applies to IP addresses in a given list, the following condition can be added:\n\n```\n{\"ipAddressIn\": [ <ip_list_object_id> ]}\n```\n\nIf you would rather exclude IP addresses in the given lists, the following condition could be added:\n\n```\n{\n  \"not\": {\n    \"ipAddressIn\": [ <ip_list_object_id_1>, <ip_list_object_id_2> ]\n  }\n}\n```\n\nYou may also include more than one condition and choose whether \"all\" or \"any\" of them must be met for the policy to apply:\n\n```\n{\n  \"all\": [\n    {\n      \"ipAddressIn\": [ <ip_list_object_id>, ... ]\n    },\n    {\n      \"deviceManaged\": true\n    },\n    {\n      \"locationIn\": {\n        countries: [ <iso_3166_country_code>, ... ]\n      }\n    }\n  ]\n}\n```"
    },
    "description": {
      "type": "string"
    }
  },
  "description": "This represents an authentication policy.  See the details of each field for valid values and restrictions."
}
object AuthnPolicyEffect 
{
  "type": "object",
  "title": "AuthnPolicyEffect",
  "required": [
    "action"
  ],
  "properties": {
    "action": {
      "enum": [
        "allow",
        "deny",
        "unknown"
      ],
      "type": "string"
    },
    "obligations": {
      "$ref": "#/components/schemas/AuthnPolicyObligations"
    }
  },
  "x-examples": {
    "example-deny": {
      "action": "deny"
    },
    "example-allow": {
      "action": "allow"
    },
    "example-allow-with-mfa": {
      "action": "allow",
      "obligations": {
        "mfa": {
          "required": true
        }
      }
    }
  }
}
object AuthnPolicyObligations 
{
  "type": "object",
  "title": "AuthnPolicyObligations",
  "properties": {
    "mfa": {
      "type": "object",
      "properties": {
        "required": {
          "type": "boolean"
        }
      }
    },
    "userVerification": {
      "type": "object",
      "properties": {
        "requirement": {
          "enum": [
            "none",
            "optional",
            "required"
          ],
          "type": "string"
        }
      }
    }
  }
}
object AuthnPolicyResourceTarget 
{
  "type": "object",
  "title": "AuthnPolicyResourceTarget",
  "required": [
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Object ID of the resource target. If undefined, then all resources of the given type are targeted."
    },
    "type": {
      "enum": [
        "user_portal",
        "application",
        "ldap"
      ],
      "type": "string"
    }
  }
}
object AuthnPolicyTargets 
{
  "type": "object",
  "title": "AuthnPolicyTargets",
  "properties": {
    "users": {
      "$ref": "#/components/schemas/AuthnPolicyUserTarget"
    },
    "resources": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AuthnPolicyResourceTarget"
      }
    },
    "userGroups": {
      "$ref": "#/components/schemas/AuthnPolicyUserGroupTarget"
    },
    "userAttributes": {
      "$ref": "#/components/schemas/AuthnPolicyUserAttributeTarget"
    }
  }
}
string AuthnPolicyType 
{
  "enum": [
    "user_portal",
    "application",
    "ldap"
  ],
  "type": "string",
  "title": "AuthnPolicyType",
  "default": "user_portal"
}
object AuthnPolicyUserAttributeFilter 
{
  "type": "object",
  "title": "AuthnPolicyUserAttributeFilter",
  "properties": {
    "field": {
      "type": "string",
      "description": "The only field that is currently supported is ldap_binding_user"
    },
    "value": {
      "$ref": "#/components/schemas/AnyValue"
    },
    "operator": {
      "enum": [
        "EQ"
      ],
      "type": "string"
    }
  }
}
object AuthnPolicyUserAttributeTarget 
{
  "type": "object",
  "title": "AuthnPolicyUserAttributeTarget",
  "properties": {
    "exclusions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AuthnPolicyUserAttributeFilter"
      }
    },
    "inclusions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AuthnPolicyUserAttributeFilter"
      }
    }
  },
  "description": "User attribute targets are currently only supported for LDAP policies."
}
object AuthnPolicyUserGroupTarget 
{
  "type": "object",
  "title": "AuthnPolicyUserGroupTarget",
  "properties": {
    "exclusions": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "inclusions": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
object AuthnPolicyUserTarget 
{
  "type": "object",
  "title": "AuthnPolicyUserTarget",
  "properties": {
    "inclusions": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Load more schemas

Versions

Version Endpoints Schemas Ingested Status
2.0 416 669 2026-05-11 current
2.0 416 669 2026-04-20
2.0 416 669 2026-04-20
2.0 416 669 2026-04-16