This endpoint is used to lookup the next upcoming scheduled state change for each user in the
given list. The users parameter is limited to 100 items per request. The results are also limited
to 100 items. This endpoint returns a max of 1 event per state per user. For example, if a user
has 3 ACTIVATED events scheduled it will return the next upcoming activation event. However, if a
user also has a SUSPENDED event scheduled along with the ACTIVATED events it will return the next
upcoming activation event and the next upcoming suspension event.

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'

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

This endpoint will return all queued Commands for an Organization.

Each element will contain the workflow ID, the command name, the launch type (e.g. manual, triggered, or scheduled), the target OS, the number of assigned devices, and the number of pending devices that have not yet ran the command.

Sample Request

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

Get the list of custom email templates

Create the custom email configuration for the specified custom email type.

This action is only available to paying customers.

Delete the custom email configuration for the specified custom email type

Get the custom email configuration for the specified custom email type

Update the custom email configuration for the specified custom email type.

This action is only available to paying customers.

This endpoint returns all active directories (LDAP, O365 Suite, G-Suite).

Sample Request

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

This endpoint returns all the Duo accounts for your organization. Note: There can currently only be one Duo account for your organization.

Sample Request

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

Registers a Duo account for an organization. Only one Duo account will be allowed,
in case an organization has a Duo account already a 409 (Conflict) code will be returned.

Sample Request

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

This endpoint returns all the Duo applications for the specified Duo account. Note: There can currently only be one Duo application for your organization.

Sample Request

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

Creates a Duo application for your organization and the specified account.

Sample Request

  curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
    "name": "Application Name",
    "apiHost": "api-1234.duosecurity.com",
    "integrationKey": "1234",
    "secretKey": "5678"
  }'

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

This endpoint returns a specific Duo application that is associated with the specified Duo account.

Sample Request

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

Updates the specified Duo application.

Sample Request

  curl -X PUT 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}' \
  -d '{
    "name": "Application Name",
    "apiHost": "api-1234.duosecurity.com",
    "integrationKey": "1234",
    "secretKey": "5678"
  }'

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

This endpoint returns a specific Duo account.

Sample Request

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

This endpoint get’s the current state of a feature trial for an org.

Sample Request

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

List the domains configured for a specific Google Workspace directory sync integration instance.

Sample Request

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

Add a domain to a specific Google Workspace directory sync integration instance. The domain must be a verified domain in Google Workspace.

Sample Request

curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/domains \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{"domain": "{domain name}"}'

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

Lists available G Suite users for import, translated to the Jumpcloud user schema.

Endpoint to list scheduled jobs for specified Google Workspace integration.

Endpoint to create a scheduled job for specified Google Workspace integration.

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

Lists G Suite users available for import.

This endpoint returns all graph translation rules for a specific G Suite instance. These rules specify how JumpCloud attributes translate to G Suite Admin SDK attributes.

Sample Request

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

This endpoint allows you to create 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 POST https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
    {Translation Rule Parameters}
  }'

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

This endpoint returns a specific 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 GET 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}'

This endpoint returns a specific G Suite.

Sample Request

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

This endpoint allows updating some attributes of a G Suite.

Sample Request

curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
    "userLockoutAction": "suspend",
    "userPasswordExpirationAction": "maintain"
  }'

Sample Request, set a default domain

curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
    "defaultDomain": {
        "id": "{domainObjectID}"
      }
  }'

Sample Request, unset the default domain

curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
    "defaultDomain": {}
  }'

Gets a Google EMM enrolled device details.

Sample Request

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

Removes the work profile and all policies from a personal/company-owned Android 8.0+ device. Company owned devices will be relinquished for personal use. Apps and data associated with the personal profile(s) are preserved.

Sample Request

curl -X POST https://console.jumpcloud.com/api/v2/google-emm/devices/{deviceId}/erase-device \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \

Locks a Google EMM enrolled device, as if the lock screen timeout had expired.

Sample Request

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

Gets an android JSON policy for a Google EMM enrolled device.

Sample Request

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

Reboots a Google EMM enrolled device. Only supported on fully managed devices running Android 7.0 or higher.

Sample Request

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

Reset the user’s password of a Google EMM enrolled device.

Sample Request

curl -X POST https://console.jumpcloud.com/api/v2/google-emm/devices/{deviceId}/resetpassword \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{ 'new_password' : 'string' }' \

Gets an enrollment token to enroll a device into Google EMM.

Sample Request

curl -X POST https://console.jumpcloud.com/api/v2/google-emm/enrollment-tokens \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \

Lists all Google EMM enterprises. An empty list indicates that the Organization is not configured with a Google EMM enterprise yet.

Note: Currently only one Google Enterprise per Organization is supported.

Sample Request

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

Creates a Google EMM enterprise.

Sample Request

curl -X POST https://console.jumpcloud.com/api/v2/google-emm/enterprises \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{ 'signupUrlName': 'string', 'enrollmentToken': 'string' }' \

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

Updates a Google EMM enterprise details.

Sample Request

curl -X PATCH https://console.jumpcloud.com/api/v2/google-emm/enterprises \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{ 'allowDeviceEnrollment': true, 'deviceGroupId': 'string' }' \

Gives a connection status between JumpCloud and Google.

Sample Request

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

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

Lists google EMM enrolled devices.

Sample Request

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

Lists active, unexpired enrollement tokens for a given enterprise.

Sample Request

curl -X GET https://console.jumpcloud.com/api/v2/google-emm/enterprises/{enterprise_object_id}/enrollment-tokens \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \

Gets an enrollment token to enroll a device into Google EMM.

Sample Request

curl -X POST https://console.jumpcloud.com/api/v2/google-emm/enterpries/{enterprise_object_id}/enrollment-tokens \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \