JumpCloud API

This endpoint allows you to list all your Active Directory Instances.

Sample Request

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

This endpoint allows you to create a new Active Directory.

Sample Request

curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/ \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
    "domain": "{DC=AD_domain_name;DC=com}"
  }'

This endpoint allows you to list all your Active Directory Agents for a given Instance.

Sample Request

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

This endpoint allows you to create a new Active Directory Agent.

Sample Request

curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{ "agent_type":"{SYNC}" }'

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}'

This endpoint returns an Active Directory agent.

Sample Request

curl -X GET 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}'

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}'

This endpoint returns a specific Active Directory.

Sample Request

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

This endpoint allows you to update Active Directory.

• AD as Authority - password in AD - 2-way sync use case is selected.
• JC as Authority - one-way sync from AD.
• Two way sync - 2-way sync use case is selected

Sample Request

curl -X PATCH https://console.jumpcloud.com/api/v2/activedirectories/{Domain_ID} \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
        "domain": "{DC=DOMAIN;DC=COM}",
        "use_case": "{ADASAUTHORITY}"
    }' \

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

This endpoint returns the association links between an Administrator and Organizations.

This endpoint allows you to grant Administrator access to an Organization.

This endpoint returns the association links between an Organization and Administrators.

Gets the aggregated policy stats for a system.

Sample Request

curl -X GET https://console.jumpcloud.com/api/v2/systems/{system_object_id}/aggregated-policy-stats \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key:{API_KEY}'

Get a list of all Apple MDM configurations. An empty topic indicates that a signed certificate from Apple has not been provided to the PUT endpoint yet.

Note: currently only one MDM configuration per organization is supported.

Sample Request

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

Retrieves an Apple MDM signed CSR Plist for an organization. The user must supply the returned plist to Apple for signing, and then provide the certificate provided by Apple back into the PUT API.

Sample Request

  curl -X GET https://console.jumpcloud.com/api/v2/applemdms/{APPLE_MDM_ID}/csr \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}'

Retrieves an Apple MDM DEP Public Key.

Sample Request

curl https://console.jumpcloud.com/api/v2/applemdms/{APPLE_MDM_ID}/depkey \
  -H 'accept: application/x-pem-file' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}'

Lists all Apple MDM devices.

The filter and sort queries will allow the following fields:
createdAt
depRegistered
enrolled
id
osVersion
serialNumber
udid

Sample Request

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

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}'

Gets a single Apple MDM device.

Sample Request

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

Clears the activation lock on the specified device.

Sample Request

  curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/clearActivationLock \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{}'

Erases a DEP-enrolled device.

Sample Request

  curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/erase \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{}'

Locks a DEP-enrolled device.

Sample Request

  curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/lock \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{}'

Pass through to request the status of an OS update

Sample Request

curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/osUpdateStatus \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{}'

Refreshes the activation lock information for a device

Sample Request

curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/refreshActivationLockInformation \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{}'

Restarts a DEP-enrolled device.

Sample Request

  curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/restart \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{"kextPaths": ["Path1", "Path2"]}'

Schedules an OS update for a device

Sample Request

curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/scheduleOSUpdate \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{"install_action": "INSTALL_ASAP", "product_key": "key"}'

Shuts down a DEP-enrolled device.

Sample Request

  curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/shutdown \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{}'

Get a list of enrollment profiles for an apple mdm.

Note: currently only one enrollment profile is supported.

Sample Request

 curl https://console.jumpcloud.com/api/v2/applemdms/{APPLE_MDM_ID}/enrollmentprofiles \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}'

Get an enrollment profile

Currently only requesting the mobileconfig is supported.

Sample Request

curl https://console.jumpcloud.com/api/v2/applemdms/{APPLE_MDM_ID}/enrollmentprofiles/{ID} \
  -H 'accept: application/x-apple-aspen-config' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}'

Refreshes the list of devices that a JumpCloud admin has added to their virtual MDM in Apple Business Manager - ABM so that they can be DEP enrolled with JumpCloud.

Sample Request

  curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/refreshdepdevices \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{}'

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}'

Updates an Apple MDM configuration. This endpoint is used to supply JumpCloud with a signed certificate from Apple in order to finalize the setup and allow JumpCloud to manage your devices. It may also be used to update the DEP Settings.

Sample Request

  curl -X PUT https://console.jumpcloud.com/api/v2/applemdms/{ID} \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
    "name": "MDM name",
    "appleSignedCert": "{CERTIFICATE}",
    "encryptedDepServerToken": "{SERVER_TOKEN}",
    "dep": {
      "welcomeScreen": {
        "title": "Welcome",
        "paragraph": "In just a few steps, you will be working securely from your Mac.",
        "button": "continue",
      },
    },
  }'

The endpoint retrieves an Application.

This endpoint allows you to create a user import job that will import new users and/or update existing users in JumpCloud from the application. The endpoint can currently only be used for applications that have an active Identity Management custom API integration. The request will fail with a “Not found” error for applications if that type of integration is not configured. To learn more about configuring this type of integration, read Import users from an external identity source using a custom API integration.

Sample Request

curl -X POST https://console.jumpcloud.com/api/v2/applications/{application_id}/import/jobs \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-org-id: {ORG_ID}' \
-d '{
    "allowUserReactivation": true,
    "operations": [
        "users.create",
        "users.update"
    ]
    "queryString": "location=Chicago&department=IT"
  }'

Get a list of users to import from an Application IdM service provider.

Deletes the specified image from an application

This endpoint sets the logo for an application.

Sample Request

curl -X POST 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/logo \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}'

Get a list of all authentication policies.

Sample Request

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

Create an authentication policy.

Sample Request

curl -X POST https://console.jumpcloud.com/api/v2/authn/policies \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
    "name": "Sample Policy",
    "disabled": false,
    "effect": {
      "action": "allow"
    },
    "targets": {
      "users": {
        "inclusions": ["ALL"]
      },
      "userGroups": {
        "exclusions": [{USER_GROUP_ID}]
      },
      "resources": [ {"type": "user_portal" } ]
    },
    "conditions":{
      "ipAddressIn": [{IP_LIST_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}'

Return a specific authentication policy.

Sample Request

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

Patch the specified authentication policy.

Sample Request

curl -X PATCH https://console.jumpcloud.com/api/v2/authn/policies/{id} \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{ "disabled": false }'

The endpoint allows you to start a bulk job to asynchronously expire users.

The endpoint allows you to start a bulk job to asynchronously unlock users.

The endpoint allows you to create a bulk job to asynchronously update users. See Update a System User for full list of attributes.

Sample Request

curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '[
	{
	  "id":"5be9fb4ddb01290001e85109",
		"firstname":"{UPDATED_FIRSTNAME}",
		"department":"{UPDATED_DEPARTMENT}",
		"attributes":[
			{"name":"Custom","value":"{ATTRIBUTE_VALUE}"}
		]
	},
	{
	  "id":"5be9fb4ddb01290001e85109",
		"firstname":"{UPDATED_FIRSTNAME}",
		"costCenter":"{UPDATED_COST_CENTER}",
		"phoneNumbers":[
			{"type":"home","number":"{HOME_PHONE_NUMBER}"},
			{"type":"work","number":"{WORK_PHONE_NUMBER}"}
		]
	}
]

The endpoint allows you to create a bulk job to asynchronously create users.
See Create a System User
for the full list of attributes.

Default User State

The state of each user in the request can be explicitly passed in or
omitted. If state is omitted, then the user will get created
using the value returned from the
Get an Organization
endpoint. The default user state for bulk created users depends on the
creation-source header. For creation-source:jumpcloud:bulk the
default state is stored in settings.newSystemUserStateDefaults.csvImport.
For other creation-source header values, the default state is stored in
settings.newSystemUserStateDefaults.applicationImport

These default state values can be changed in the admin portal settings
or by using the
Update an Organization
endpoint.

Sample Request

curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '[
  {
    "email":"{email}",
    "firstname":"{firstname}",
    "lastname":"{firstname}",
    "username":"{username}",
    "attributes":[
      {
        "name":"EmployeeID",
        "value":"0000"
      },
      {
        "name":"Custom",
        "value":"attribute"
      }
    ]
  }
]'

This endpoint will return the results of particular user import or update job request.

Sample Request

curl -X GET \
  https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'

The endpoint allows you to list scheduled statechange jobs.

Sample Request

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

This endpoint allows you to create scheduled statechange jobs.

Sample Request

curl -X POST "https://console.jumpcloud.com/api/v2/bulk/userstates" \
  -H 'x-api-key: {API_KEY}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "user_ids": ["{User_ID_1}", "{User_ID_2}", "{User_ID_3}"],
    "state": "SUSPENDED",
    "start_date": "2000-01-01T00:00:00.000Z"
  }'