Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://console.jumpcloud.com/api/v2
/activedirectories
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /activedirectories
/activedirectories
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}" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"$ref": "#/components/requestBodies/active-directory"
}
POST /activedirectories
/activedirectories/{activedirectory_id}/agents
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /activedirectories/{activedirectory_id}/agents
/activedirectories/{activedirectory_id}/agents
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}" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/active-directory-agent"
}
}
}
}
POST /activedirectories/{activedirectory_id}/agents
/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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
DELETE /activedirectories/{activedirectory_id}/agents/{agent_id}
/activedirectories/{activedirectory_id}/agents/{agent_id}
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /activedirectories/{activedirectory_id}/agents/{agent_id}
/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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
DELETE /activedirectories/{id}
/activedirectories/{id}
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /activedirectories/{id}
/activedirectories/{id}
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}" }' \ ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"$ref": "#/components/requestBodies/active-directory"
}
PATCH /activedirectories/{id}
/administrators/{administrator_id}/organizationlinks/{id}
This endpoint removes the association link between an Administrator and an Organization.
DELETE /administrators/{administrator_id}/organizationlinks/{id}
/administrators/{id}/organizationlinks
This endpoint returns the association links between an Administrator and Organizations.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional |
GET /administrators/{id}/organizationlinks
/administrators/{id}/organizationlinks
This endpoint allows you to grant Administrator access to an Organization.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdministratorOrganizationLinkReq"
}
}
}
}
POST /administrators/{id}/organizationlinks
/organizations/{id}/administratorlinks
This endpoint returns the association links between an Organization and Administrators.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional |
GET /organizations/{id}/administratorlinks
/systems/{systemObjectId}/aggregated-policy-stats
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| systemObjectId | path | required | string | |
| organizationObjectId | query | optional | string |
GET /systems/{systemObjectId}/aggregated-policy-stats
/applemdms
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /applemdms
/applemdms/{apple_mdm_id}/csr
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /applemdms/{apple_mdm_id}/csr
/applemdms/{apple_mdm_id}/depkey
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /applemdms/{apple_mdm_id}/depkey
/applemdms/{apple_mdm_id}/devices
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 '{}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /applemdms/{apple_mdm_id}/devices
/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}' ```
DELETE /applemdms/{apple_mdm_id}/devices/{device_id}
/applemdms/{apple_mdm_id}/devices/{device_id}
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}' ```
GET /applemdms/{apple_mdm_id}/devices/{device_id}
/applemdms/{apple_mdm_id}/devices/{device_id}/clearActivationLock
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 '{}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
POST /applemdms/{apple_mdm_id}/devices/{device_id}/clearActivationLock
/applemdms/{apple_mdm_id}/devices/{device_id}/erase
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 '{}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplemdmsDeviceseraseRequest"
}
}
}
}
POST /applemdms/{apple_mdm_id}/devices/{device_id}/erase
/applemdms/{apple_mdm_id}/devices/{device_id}/lock
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 '{}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplemdmsDeviceslockRequest"
}
}
}
}
POST /applemdms/{apple_mdm_id}/devices/{device_id}/lock
/applemdms/{apple_mdm_id}/devices/{device_id}/osUpdateStatus
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 '{}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
POST /applemdms/{apple_mdm_id}/devices/{device_id}/osUpdateStatus
/applemdms/{apple_mdm_id}/devices/{device_id}/refreshActivationLockInformation
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 '{}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
POST /applemdms/{apple_mdm_id}/devices/{device_id}/refreshActivationLockInformation
/applemdms/{apple_mdm_id}/devices/{device_id}/restart
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"]}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplemdmsDevicesrestartRequest"
}
}
},
"x-examples": {
"example-1": {
"kextPaths": [
"/path/to/kext1",
"/path/to/kext2"
]
}
}
}
POST /applemdms/{apple_mdm_id}/devices/{device_id}/restart
/applemdms/{apple_mdm_id}/devices/{device_id}/scheduleOSUpdate
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"}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleOSUpdate"
}
}
}
}
POST /applemdms/{apple_mdm_id}/devices/{device_id}/scheduleOSUpdate
/applemdms/{apple_mdm_id}/devices/{device_id}/shutdown
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 '{}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
POST /applemdms/{apple_mdm_id}/devices/{device_id}/shutdown
/applemdms/{apple_mdm_id}/enrollmentprofiles
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /applemdms/{apple_mdm_id}/enrollmentprofiles
/applemdms/{apple_mdm_id}/enrollmentprofiles/{id}
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /applemdms/{apple_mdm_id}/enrollmentprofiles/{id}
/applemdms/{apple_mdm_id}/refreshdepdevices
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 '{}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
POST /applemdms/{apple_mdm_id}/refreshdepdevices
/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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
DELETE /applemdms/{id}
/applemdms/{id}
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", }, }, }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/apple-mdm-patch"
}
}
}
}
PUT /applemdms/{id}
/applications/{application_id}
The endpoint retrieves an Application.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /applications/{application_id}
/applications/{application_id}/import/jobs
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](https://support.jumpcloud.com/support/s/article/Import-users-from-a-custom-rest-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" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportUsersRequest"
}
}
}
}
POST /applications/{application_id}/import/jobs
/applications/{application_id}/logo
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| application_id | path | required | string | |
| optional |
{
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ApplicationsPostLogoRequest"
}
}
}
}
POST /applications/{application_id}/logo
/applications/{application_id}/logo
Deletes the specified image from an application
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| application_id | path | required | string | |
| optional |
DELETE /applications/{application_id}/logo
/applications/{application_id}/import/users
Get a list of users to import from an Application IdM service provider.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| filter | query | optional | string | Filter users by a search term |
| query | query | optional | string | URL query to merge with the service provider request |
| sort | query | optional | string | Sort users by supported fields |
| sortOrder | query | optional | string | |
| optional | ||||
| optional | ||||
| optional |
GET /applications/{application_id}/import/users
/authn/policies
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /authn/policies
/authn/policies
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}] } }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"$ref": "#/components/requestBodies/AuthnPolicy"
}
POST /authn/policies
/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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
DELETE /authn/policies/{id}
/authn/policies/{id}
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /authn/policies/{id}
/authn/policies/{id}
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 }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"$ref": "#/components/requestBodies/AuthnPolicy"
}
PATCH /authn/policies/{id}
/bulk/user/expires
The endpoint allows you to start a bulk job to asynchronously expire users.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkUserExpiresRequest"
}
}
}
}
POST /bulk/user/expires
/bulk/user/unlocks
The endpoint allows you to start a bulk job to asynchronously unlock users.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkUserUnlocksRequest"
}
}
}
}
POST /bulk/user/unlocks
/bulk/users
The endpoint allows you to create a bulk job to asynchronously update users. See [Update a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_put) 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}"} ] } ] ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkUsersUpdateRequest"
}
}
}
}
PATCH /bulk/users
/bulk/users
The endpoint allows you to create a bulk job to asynchronously create users. See [Create a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_post) 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](https://docs.jumpcloud.com/api/1.0/index.html#operation/organizations_get) 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](https://docs.jumpcloud.com/api/1.0/index.html#operation/organization_put) 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" } ] } ]' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| creation-source | header | optional | string | Defines the creation-source header for gapps, o365 and workdays requests. If the header isn't sent, the default value is `jumpcloud:bulk`, if you send the header with a malformed value you receive a 400 error. |
{
"$ref": "#/components/requestBodies/bulk-user-createArray"
}
POST /bulk/users
/bulk/users/{job_id}/results
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional |
GET /bulk/users/{job_id}/results
/bulk/userstates
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' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| userid | query | optional | string | The systemuser id to filter by. |
GET /bulk/userstates
/bulk/userstates
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" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/bulk-scheduled-statechange-create"
}
}
}
}
POST /bulk/userstates
/bulk/userstates/eventlist/next
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.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| users | query | required | array | A list of system user IDs, limited to 100 items. |
| optional | ||||
| optional |
GET /bulk/userstates/eventlist/next
/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' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
DELETE /bulk/userstates/{id}
/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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
DELETE /commandqueue/{workflow_instance_id}
/queuedcommand/workflows
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /queuedcommand/workflows
/customemail/templates
Get the list of custom email templates
GET /customemail/templates
/customemails
Create the custom email configuration for the specified custom email type. This action is only available to paying customers.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"$ref": "#/components/requestBodies/CustomEmail"
}
POST /customemails
/customemails/{custom_email_type}
Delete the custom email configuration for the specified custom email type
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
DELETE /customemails/{custom_email_type}
/customemails/{custom_email_type}
Get the custom email configuration for the specified custom email type
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /customemails/{custom_email_type}
/customemails/{custom_email_type}
Update the custom email configuration for the specified custom email type. This action is only available to paying customers.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"$ref": "#/components/requestBodies/CustomEmail"
}
PUT /customemails/{custom_email_type}
/directories
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /directories
/duo/accounts
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /duo/accounts
/duo/accounts
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 '{}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
POST /duo/accounts
/duo/accounts/{account_id}/applications
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /duo/accounts/{account_id}/applications
/duo/accounts/{account_id}/applications
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" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DuoApplicationReq"
}
}
}
}
POST /duo/accounts/{account_id}/applications
/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}'' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
DELETE /duo/accounts/{account_id}/applications/{application_id}
/duo/accounts/{account_id}/applications/{application_id}
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /duo/accounts/{account_id}/applications/{application_id}
/duo/accounts/{account_id}/applications/{application_id}
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" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DuoApplicationUpdateReq"
}
}
}
}
PUT /duo/accounts/{account_id}/applications/{application_id}
/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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
DELETE /duo/accounts/{id}
/duo/accounts/{id}
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /duo/accounts/{id}
/featureTrials/{feature_code}
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| feature_code | path | required | string |
GET /featureTrials/{feature_code}
/gsuites/{gsuite_id}/domains
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| gsuite_id | path | required | string | Id for the specific Google Workspace directory sync integration instance.. |
| limit | query | optional | string | The number of records to return at once. Limited to 100. |
| skip | query | optional | string | The offset into the records to return. |
GET /gsuites/{gsuite_id}/domains
/gsuites/{gsuite_id}/domains
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}"}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| gsuite_id | path | required | string | Id for the specific Google Workspace directory sync integration instance. |
| domain | query | optional | string |
POST /gsuites/{gsuite_id}/domains
/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}' ```
| 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. |
DELETE /gsuites/{gsuite_id}/domains/{domainId}
/gsuites/{gsuite_id}/import/schedules
Endpoint to list scheduled jobs for specified Google Workspace integration.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| gsuite_id | path | required | string | ObjectID of the Google Workspace integration |
GET /gsuites/{gsuite_id}/import/schedules
/gsuites/{gsuite_id}/import/schedules
Endpoint to create a scheduled job for specified Google Workspace integration.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| gsuite_id | path | required | string | ObjectID of the Google Workspace integration |
POST /gsuites/{gsuite_id}/import/schedules
/gsuites/{gsuite_id}/import/schedules/{scheduledJobId}
Endpoint to delete the specified scheduled job from gapps and kala.
| 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 |
DELETE /gsuites/{gsuite_id}/import/schedules/{scheduledJobId}
/gsuites/{gsuite_id}/translationrules
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](https://developers.google.com/admin-sdk/directory/) 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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /gsuites/{gsuite_id}/translationrules
/gsuites/{gsuite_id}/translationrules
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](https://developers.google.com/admin-sdk/directory/) 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} }' ```
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GSuiteTranslationRuleRequest"
}
}
}
}
POST /gsuites/{gsuite_id}/translationrules
/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](https://developers.google.com/admin-sdk/directory/) 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}' ```
DELETE /gsuites/{gsuite_id}/translationrules/{id}
/gsuites/{gsuite_id}/translationrules/{id}
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](https://developers.google.com/admin-sdk/directory/) 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}' ```
GET /gsuites/{gsuite_id}/translationrules/{id}
/gsuites/{id}
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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /gsuites/{id}
/gsuites/{id}
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": {} }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/gsuite"
}
}
}
}
PATCH /gsuites/{id}
/gsuites/{gsuite_id}/import/jumpcloudusers
Lists available G Suite users for import, translated to the Jumpcloud user schema.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /gsuites/{gsuite_id}/import/jumpcloudusers
/gsuites/{gsuite_id}/import/users
Lists G Suite users available for import.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /gsuites/{gsuite_id}/import/users
/google-emm/devices/{deviceId}
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}' \ ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| deviceId | path | required | string |
GET /google-emm/devices/{deviceId}
/google-emm/devices/{deviceId}/erase-device
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}' \ ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| deviceId | path | required | string |
{
"$ref": "#/components/requestBodies/Devices_EraseDeviceBody"
}
POST /google-emm/devices/{deviceId}/erase-device
/google-emm/devices/{deviceId}/lock
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}' \ ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| deviceId | path | required | string |
{
"$ref": "#/components/requestBodies/Devices_EraseDeviceBody"
}
POST /google-emm/devices/{deviceId}/lock
/google-emm/devices/{deviceId}/policy_results
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}' \ ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| deviceId | path | required | string |
GET /google-emm/devices/{deviceId}/policy_results
/google-emm/devices/{deviceId}/reboot
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}' \ ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| deviceId | path | required | string |
{
"$ref": "#/components/requestBodies/Devices_EraseDeviceBody"
}
POST /google-emm/devices/{deviceId}/reboot
/google-emm/devices/{deviceId}/resetpassword
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' }' \ ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| deviceId | path | required | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DevicesResetPasswordRequest"
}
}
},
"required": true
}
POST /google-emm/devices/{deviceId}/resetpassword
/google-emm/enrollment-tokens
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}' \ ```
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/jumpcloud.google_emm.CreateEnrollmentTokenRequest"
}
}
},
"required": true
}
POST /google-emm/enrollment-tokens
/google-emm/enterprises
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}' \ ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | string | The number of records to return at once. Limited to 100. |
| skip | query | optional | string | The offset into the records to return. |
GET /google-emm/enterprises
/google-emm/enterprises
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' }' \ ```
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/jumpcloud.google_emm.CreateEnterpriseRequest"
}
}
},
"required": true
}
POST /google-emm/enterprises
/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}' \ ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| enterpriseId | path | required | string |
DELETE /google-emm/enterprises/{enterpriseId}
/google-emm/enterprises/{enterpriseId}
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' }' \ ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| enterpriseId | path | required | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnterprisesPatchEnterpriseRequest"
}
}
},
"required": true
}
PATCH /google-emm/enterprises/{enterpriseId}
/google-emm/enterprises/{enterpriseId}/connection-status
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}' \ ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| enterpriseId | path | required | string |
GET /google-emm/enterprises/{enterpriseId}/connection-status
/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}' \ ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| enterpriseId | path | required | string | |
| tokenId | path | required | string |
DELETE /google-emm/enterprises/{enterpriseId}/enrollment-tokens/{tokenId}
/google-emm/enterprises/{enterpriseObjectId}/devices
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}' \ ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| enterpriseObjectId | path | required | string | |
| limit | query | optional | string | The number of records to return at once. Limited to 100. |
| skip | query | optional | string | The offset into the records to return. |
| filter | query | optional | array |
GET /google-emm/enterprises/{enterpriseObjectId}/devices
/google-emm/enterprises/{enterpriseObjectId}/enrollment-tokens
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}' \ ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| enterpriseObjectId | path | required | string | |
| limit | query | optional | string | The number of records to return at once. Limited to 100. |
| skip | query | optional | string | The offset into the records to return. |
| filter | query | optional | array | |
| sort | query | optional | string | Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with - to sort descending. |
GET /google-emm/enterprises/{enterpriseObjectId}/enrollment-tokens
/google-emm/enterprises/{enterpriseObjectId}/enrollment-tokens
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}' \ ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| enterpriseObjectId | path | required | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnrollmentTokensCreateEnterprisesEnrollmentTokenRequest"
}
}
},
"required": true
}
POST /google-emm/enterprises/{enterpriseObjectId}/enrollment-tokens
/google-emm/signup-urls
Creates a Google EMM enterprise signup URL. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/google-emm/signup-urls \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ ```
POST /google-emm/signup-urls
/google-emm/web-tokens
Creates a web token to access an embeddable managed Google Play web UI for a given Google EMM enterprise. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/google-emm/web-tokens \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ ```
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/jumpcloud.google_emm.CreateWebTokenRequest"
}
}
},
"required": true
}
POST /google-emm/web-tokens
/activedirectories/{activedirectory_id}/associations
This endpoint returns the direct associations of this Active Directory instance. A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. #### Sample Request ``` curl -X GET 'https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/associations?targets=user \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /activedirectories/{activedirectory_id}/associations
/activedirectories/{activedirectory_id}/associations
This endpoint allows you to manage the _direct_ associations of an Active Directory instance. A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{AD_Instance_ID}/associations \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "op": "add", "type": "user", "id": "{User_ID}" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GraphOperation-ActiveDirectory"
}
}
}
}
POST /activedirectories/{activedirectory_id}/associations
/activedirectories/{activedirectory_id}/usergroups
This endpoint will return all Users Groups bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Active Directory instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Active Directory instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/usergroups \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /activedirectories/{activedirectory_id}/usergroups
/activedirectories/{activedirectory_id}/users
This endpoint will return all Users bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Active Directory instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Active Directory instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/users \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /activedirectories/{activedirectory_id}/users
/applications/{application_id}/associations
This endpoint will return the _direct_ associations of an Application. A direct association can be a non-homogeneous relationship between 2 different objects, for example Applications and User Groups. #### Sample Request ``` curl -X GET 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations?targets=user_group \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /applications/{application_id}/associations
/applications/{application_id}/associations
This endpoint allows you to manage the _direct_ associations of an Application. A direct association can be a non-homogeneous relationship between 2 different objects, for example Application and User Groups. #### Sample Request ``` curl -X POST 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations' \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "op": "add", "type": "user_group", "id": "{Group_ID}" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GraphOperation-Application"
}
}
}
}
POST /applications/{application_id}/associations
/applications/{application_id}/usergroups
This endpoint will return all Users Groups bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Application to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Application. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/usergroups \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /applications/{application_id}/usergroups
/applications/{application_id}/users
This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /applications/{application_id}/users
/commands/{command_id}/associations
This endpoint will return the _direct_ associations of this Command. A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations?targets=system_group \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /commands/{command_id}/associations
/commands/{command_id}/associations
This endpoint will allow you to manage the _direct_ associations of this Command. A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "op": "add", "type": "system_group", "id": "Group_ID" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GraphOperation-Command"
}
}
}
}
POST /commands/{command_id}/associations
/commands/{command_id}/systemgroups
This endpoint will return all System Groups bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Command to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Command. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systemgroups \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /commands/{command_id}/systemgroups
/commands/{command_id}/systems
This endpoint will return all Systems bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Command to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Command. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systems \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /commands/{command_id}/systems
/gsuites/{gsuite_id}/associations
This endpoint returns the _direct_ associations of this G Suite instance. A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. #### Sample Request ``` curl -X GET 'https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations?targets=user_group \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /gsuites/{gsuite_id}/associations
/gsuites/{gsuite_id}/associations
This endpoint returns the _direct_ associations of this G Suite instance. A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "op": "add", "type": "user_group", "id": "{Group_ID}" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GraphOperation-GSuite"
}
}
}
}
POST /gsuites/{gsuite_id}/associations
/gsuites/{gsuite_id}/usergroups
This endpoint will return all User Groups bound to an G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this G Suite instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this G Suite instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSuite_ID}/usergroups \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /gsuites/{gsuite_id}/usergroups
/gsuites/{gsuite_id}/users
This endpoint will return all Users bound to a G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this G Suite instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this G Suite instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/users \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /gsuites/{gsuite_id}/users
/identity-provider/policies/{idp_routing_policy_id}/associations
This endpoint returns the _direct_ associations of a Routing Policy. A direct association can be a non-homogeneous relationship between 2 different objects, for example a Routing Policy and Users. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/identity-provider/policies/{IDP_ROUTING_POLICY_ID}/associations?targets=user_group \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /identity-provider/policies/{idp_routing_policy_id}/associations
/identity-provider/policies/{idp_routing_policy_id}/associations
This endpoint manages the _direct_ associations of a Routing Policy. A direct association can be a non-homogeneous relationship between 2 different objects, for example a Routing Policy and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/identity-provider/policies/{IDP_ROUTING_POLICY_ID}/associations?targets=user \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' -d '{"type":"user", "id":"{USER_ID}", "op":"add"}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GraphOperation-IDPRoutingPolicy"
}
}
}
}
POST /identity-provider/policies/{idp_routing_policy_id}/associations
/identity-provider/policies/{idp_routing_policy_id}/associations/usergroups
This endpoint will return all Users Groups bound to a routing policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this routing policy instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this routing policy. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/identity-provider/policies/{id}/associations/usergroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /identity-provider/policies/{idp_routing_policy_id}/associations/usergroups
/identity-provider/policies/{idp_routing_policy_id}/associations/users
This endpoint will return all Users bound to a routing policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this routing policy to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this routing policy. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/identity-provider/policies/{id}/associations/users \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /identity-provider/policies/{idp_routing_policy_id}/associations/users
/ldapservers/{ldapserver_id}/associations
This endpoint returns the _direct_ associations of this LDAP Server. A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. #### Sample Request ``` curl -X GET 'https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations?targets=user_group \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /ldapservers/{ldapserver_id}/associations
/ldapservers/{ldapserver_id}/associations
This endpoint allows you to manage the _direct_ associations of a LDAP Server. A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "op": "add", "type": "user", "id": "{User_ID}" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GraphOperation-LdapServer"
}
}
}
}
POST /ldapservers/{ldapserver_id}/associations
/ldapservers/{ldapserver_id}/usergroups
This endpoint will return all Users Groups bound to a LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this LDAP server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this LDAP server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/usergroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /ldapservers/{ldapserver_id}/usergroups
/ldapservers/{ldapserver_id}/users
This endpoint will return all Users bound to an LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this LDAP server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this LDAP server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /ldapservers/{ldapserver_id}/users
/office365s/{office365_id}/associations
This endpoint returns _direct_ associations of an Office 365 instance. A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. #### Sample Request ``` curl -X GET 'https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations?targets=user_group' \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /office365s/{office365_id}/associations
/office365s/{office365_id}/associations
This endpoint allows you to manage the _direct_ associations of a Office 365 instance. A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "op": "add", "type": "user_group", "id": "{Group_ID}" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GraphOperation-Office365"
}
}
}
}
POST /office365s/{office365_id}/associations
/office365s/{office365_id}/usergroups
This endpoint will return all Users Groups bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Office 365 instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Office 365 instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID/usergroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /office365s/{office365_id}/usergroups
/office365s/{office365_id}/users
This endpoint will return all Users bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Office 365 instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Office 365 instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/users \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /office365s/{office365_id}/users
/policies/{policy_id}/associations
This endpoint returns the _direct_ associations of a Policy. A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. #### Sample Request ``` curl -X GET 'https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations?targets=system_group \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /policies/{policy_id}/associations
/policies/{policy_id}/associations
This endpoint allows you to manage the _direct_ associations of a Policy. A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations/ \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "op": "add", "type": "system_group", "id": "{Group_ID}" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GraphOperation-Policy"
}
}
}
}
POST /policies/{policy_id}/associations
/policies/{policy_id}/memberof
This endpoint returns all the Policy Groups a Policy is a member of. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/memberof \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /policies/{policy_id}/memberof
/policies/{policy_id}/systemgroups
This endpoint will return all Systems Groups bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Policy to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systemgroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /policies/{policy_id}/systemgroups
/policies/{policy_id}/systems
This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /policies/{policy_id}/systems
/systems/{system_id}/policystatuses
This endpoint returns the policy results for a particular system. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policystatuses \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systems/{system_id}/policystatuses
/policygroups/{group_id}/associations
This endpoint returns the _direct_ associations of this Policy Group. A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations?targets=system \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /policygroups/{group_id}/associations
/policygroups/{group_id}/associations
This endpoint manages the _direct_ associations of this Policy Group. A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "op": "add", "type": "system", "id": "{SystemID}" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GraphOperation-PolicyGroup"
}
}
}
}
POST /policygroups/{group_id}/associations
/policygroups/{group_id}/systemgroups
This endpoint will return all System Groups bound to a Policy Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Policy Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/systemgroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /policygroups/{group_id}/systemgroups
/policygroups/{group_id}/systems
This endpoint will return all Systems bound to a Policy Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Policy Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/systems \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /policygroups/{group_id}/systems
/policygroups/{group_id}/members
This endpoint returns the Policy members of a Policy Group. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/members \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional |
GET /policygroups/{group_id}/members
/policygroups/{group_id}/members
This endpoint allows you to manage the Policy members of a Policy Group. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/members \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "op": "add", "type": "policy", "id": "{Policy_ID}" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GraphOperation-PolicyGroup-Member"
}
}
}
}
POST /policygroups/{group_id}/members
/policygroups/{group_id}/membership
This endpoint returns all Policy members that are a member of this Policy Group. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/membership \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /policygroups/{group_id}/membership
/radiusservers/{radiusserver_id}/associations
This endpoint returns the _direct_ associations of a Radius Server. A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations?targets=user_group \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /radiusservers/{radiusserver_id}/associations
/radiusservers/{radiusserver_id}/associations
This endpoint allows you to manage the _direct_ associations of a Radius Server. A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "type":"user", "id":"{USER_ID}", "op":"add" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GraphOperation-RadiusServer"
}
}
}
}
POST /radiusservers/{radiusserver_id}/associations
/radiusservers/{radiusserver_id}/usergroups
This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /radiusservers/{radiusserver_id}/usergroups
/radiusservers/{radiusserver_id}/users
This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /radiusservers/{radiusserver_id}/users
/softwareapps/{software_app_id}/associations
This endpoint will return the _direct_ associations of a Software Application. A direct association can be a non-homogeneous relationship between 2 different objects, for example Software Application and System Groups. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations?targets=system_group \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /softwareapps/{software_app_id}/associations
/softwareapps/{software_app_id}/associations
This endpoint allows you to associate or disassociate a software application to a system or system group. #### Sample Request ``` $ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "id": "<object_id>", "op": "add", "type": "system" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GraphOperation-SoftwareApp"
}
}
}
}
POST /softwareapps/{software_app_id}/associations
/softwareapps/{software_app_id}/systemgroups
This endpoint will return all Systems Groups bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Software App to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Software App. See `/associations` endpoint to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systemgroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /softwareapps/{software_app_id}/systemgroups
/softwareapps/{software_app_id}/systems
This endpoint will return all Systems bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Software App to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Software App. See `/associations` endpoint to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systems \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /softwareapps/{software_app_id}/systems
/systemgroups/{group_id}/commands
This endpoint will return all Commands bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System Group to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/commands \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systemgroups/{group_id}/commands
/systemgroups/{group_id}/associations
This endpoint returns the _direct_ associations of a System Group. A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations?targets=user \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systemgroups/{group_id}/associations
/systemgroups/{group_id}/associations
This endpoint allows you to manage the _direct_ associations of a System Group. A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "op": "add", "type": "user", "id": "{UserID}" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GraphOperation-SystemGroup"
}
}
}
}
POST /systemgroups/{group_id}/associations
/systemgroups/{group_id}/policies
This endpoint will return all Policies bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System Group to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System Group. See `/members` and `/associations` endpoints to manage those collections. This endpoint is not public yet as we haven't finished the code. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policies \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systemgroups/{group_id}/policies
/systemgroups/{group_id}/policygroups
This endpoint will return all Policy Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System Group to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policygroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systemgroups/{group_id}/policygroups
/systemgroups/{group_id}/usergroups
This endpoint will return all User Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System Group to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/usergroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systemgroups/{group_id}/usergroups
/systemgroups/{group_id}/users
This endpoint will return all Users bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System Group to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/users \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systemgroups/{group_id}/users
/systemgroups/{group_id}/members
This endpoint returns the system members of a System Group. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional |
GET /systemgroups/{group_id}/members
/systemgroups/{group_id}/members
This endpoint allows you to manage the system members of a System Group. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "op": "add", "type": "system", "id": "{System_ID}" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GraphOperation-SystemGroup-Member"
}
}
}
}
POST /systemgroups/{group_id}/members
/systemgroups/{group_id}/membership
This endpoint returns all Systems that are a member of this System Group. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID/membership \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systemgroups/{group_id}/membership
/systems/{system_id}/associations
This endpoint returns the _direct_ associations of a System. A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations?targets=user \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systems/{system_id}/associations
/systems/{system_id}/associations
This endpoint allows you to manage the _direct_ associations of a System. A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "attributes": { "sudo": { "enabled": true, "withoutPassword": false } }, "op": "add", "type": "user", "id": "UserID" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GraphOperation-System"
}
}
}
}
POST /systems/{system_id}/associations
/systems/{system_id}/commands
This endpoint will return all Commands bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/commands \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systems/{system_id}/commands
/systems/{system_id}/memberof
This endpoint returns all the System Groups a System is a member of. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/memberof \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systems/{system_id}/memberof
/systems/{system_id}/policies
This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. See `/members` and `/associations` endpoints to manage those collections. This endpoint is not yet public as we have finish the code. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systems/{system_id}/policies
/systems/{system_id}/policygroups
This endpoint will return all Policy Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policygroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systems/{system_id}/policygroups
/systems/{system_id}/usergroups
This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systems/{system_id}/usergroups
/systems/{system_id}/users
This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systems/{system_id}/users
/usergroups/{group_id}/activedirectories
This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /usergroups/{group_id}/activedirectories
/usergroups/{group_id}/applications
This endpoint will return all Applications bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/applications \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /usergroups/{group_id}/applications
/usergroups/{group_id}/associations
This endpoint returns the _direct_ associations of this User Group. A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations?targets=system \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /usergroups/{group_id}/associations
/usergroups/{group_id}/associations
This endpoint manages the _direct_ associations of this User Group. A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "op": "add", "type": "system", "id": "{SystemID}" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GraphOperation-UserGroup"
}
}
}
}
POST /usergroups/{group_id}/associations
/usergroups/{group_id}/directories
This endpoint will return all Directories bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directories from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/directories \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /usergroups/{group_id}/directories
/usergroups/{group_id}/gsuites
This endpoint will return all G Suite Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID/gsuites \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /usergroups/{group_id}/gsuites
/usergroups/{group_id}/ldapservers
This endpoint will return all LDAP Servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/ldapservers \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /usergroups/{group_id}/ldapservers
/usergroups/{group_id}/office365s
This endpoint will return all Office 365 instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/office365s \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /usergroups/{group_id}/office365s
/usergroups/{group_id}/radiusservers
This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /usergroups/{group_id}/radiusservers
/usergroups/{group_id}/systemgroups
This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /usergroups/{group_id}/systemgroups
/usergroups/{group_id}/systems
This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /usergroups/{group_id}/systems
/usergroups/{group_id}/members
This endpoint returns the user members of a User Group. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional |
GET /usergroups/{group_id}/members
/usergroups/{group_id}/members
This endpoint allows you to manage the user members of a User Group. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "op": "add", "type": "user", "id": "{User_ID}" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GraphOperation-UserGroup-Member"
}
}
}
}
POST /usergroups/{group_id}/members
/usergroups/{group_id}/membership
This endpoint returns all users members that are a member of this User Group. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/membership \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /usergroups/{group_id}/membership
/users/{user_id}/activedirectories
This endpoint will return all Active Directory Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Active Directory instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/activedirectories \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /users/{user_id}/activedirectories
/users/{user_id}/applications
This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /users/{user_id}/applications
/users/{user_id}/associations
This endpoint returns the _direct_ associations of a User. A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/associations?targets=system_group \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /users/{user_id}/associations
/users/{user_id}/associations
This endpoint allows you to manage the _direct_ associations of a User. A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "attributes": { "sudo": { "enabled": true, "withoutPassword": false } }, "op": "add", "type": "system_group", "id": "{GroupID}" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GraphOperation-User"
}
}
}
}
POST /users/{user_id}/associations
/users/{user_id}/directories
This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /users/{user_id}/directories
/users/{user_id}/gsuites
This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /users/{user_id}/gsuites
/users/{user_id}/ldapservers
This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /users/{user_id}/ldapservers
/users/{user_id}/memberof
This endpoint returns all the User Groups a User is a member of. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/memberof \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /users/{user_id}/memberof
/users/{user_id}/office365s
This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /users/{user_id}/office365s
/users/{user_id}/radiusservers
This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /users/{user_id}/radiusservers
/users/{user_id}/systemgroups
This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /users/{user_id}/systemgroups
/users/{user_id}/systems
This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /users/{user_id}/systems
/groups
This endpoint returns all Groups that exist in your organization. #### Available filter fields: - `name` - `disabled` - `type` #### Sample Request ``` curl -X GET \ https://console.jumpcloud.com/api/v2/groups \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /groups
/iplists
Retrieve all IP lists. #### Sample Request ``` curl https://console.jumpcloud.com/api/v2/iplists \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /iplists
/iplists
Create an IP list. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/iplists \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "name": "Sample IP List", "ips": [ "192.168.10.12", "192.168.10.20 - 192.168.10.30", "123.225.10.0/32" ] }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"$ref": "#/components/requestBodies/IPListRequest"
}
POST /iplists
/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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
DELETE /iplists/{id}
/iplists/{id}
Return a specific IP list. #### Sample Request ``` curl https://console.jumpcloud.com/api/v2/iplists/{id} \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /iplists/{id}
/iplists/{id}
Update a specific IP list. #### Sample Request ``` curl -X PATCH https://console.jumpcloud.com/api/v2/iplists/{id} \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{"name": "New IP List Name"}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"$ref": "#/components/requestBodies/IPListRequest"
}
PATCH /iplists/{id}
/iplists/{id}
Replace a specific IP list. #### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/iplists/{id} \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "name": "Sample IP List", "ips": [ "192.168.10.10" ] }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"$ref": "#/components/requestBodies/IPListRequest"
}
PUT /iplists/{id}
/ldapservers
This endpoint returns the object IDs of your LDAP servers. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/ \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}'
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /ldapservers
/ldapservers/{id}
This endpoint returns a specific LDAP server. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /ldapservers/{id}
/ldapservers/{id}
This endpoint allows updating some attributes of an LDAP server. Sample Request ``` curl -X PATCH https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "userLockoutAction": "remove", "userPasswordExpirationAction": "disable" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LdapserversPatchRequest"
}
}
}
}
PATCH /ldapservers/{id}
/logos/{id}
Return the logo image associated with the specified id
GET /logos/{id}
/microsoft-mdm/configuration-files
This endpoint allows you to download the config file.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/jumpcloud.microsoft_mdm.DownloadConfigFilesRequest"
}
}
},
"required": true
}
POST /microsoft-mdm/configuration-files
/office365s/{office365_id}
This endpoint returns a specific Office 365 instance. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /office365s/{office365_id}
/office365s/{office365_id}
This endpoint allows updating some attributes of an Office 365 instance. ##### Sample Request ``` curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "userLockoutAction": "maintain", "userPasswordExpirationAction": "suspend", }' ``` Sample Request, set a default domain ``` curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_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/office365s/{OFFICE365_ID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "defaultDomain": {} }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/office365"
}
}
}
}
PATCH /office365s/{office365_id}
/office365s/{office365_id}/domains
List the domains configured for a specific M365/Azure AD directory sync integration instance. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/domains \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| office365_id | path | required | string | Id for the specific M365/Azure AD directory sync integration instance. |
| limit | query | optional | string | The number of records to return at once. Limited to 100. |
| skip | query | optional | string | The offset into the records to return. |
GET /office365s/{office365_id}/domains
/office365s/{office365_id}/domains
Add a domain to a specific M365/Azure AD directory sync integration instance. The domain must be a verified domain in M365/Azure AD. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/domains \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{"domain": "{domain name}"}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| office365_id | path | required | string | Id for the specific M365/Azure AD directory sync integration instance. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainsInsertRequest"
}
}
},
"required": true
}
POST /office365s/{office365_id}/domains
/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}' ```
| 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. |
DELETE /office365s/{office365_id}/domains/{domain_id}
/office365s/{office365_id}/translationrules
This endpoint returns all translation rules for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /office365s/{office365_id}/translationrules
/office365s/{office365_id}/translationrules
This endpoint allows you to create a translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ {Translation Rule Parameters} }' ```
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Office365TranslationRuleRequest"
}
}
}
}
POST /office365s/{office365_id}/translationrules
/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](https://developer.microsoft.com/en-us/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}' ```
DELETE /office365s/{office365_id}/translationrules/{id}
/office365s/{office365_id}/translationrules/{id}
This endpoint returns a specific translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. ###### Sample Request ``` curl -X GET 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}' ```
GET /office365s/{office365_id}/translationrules/{id}
/office365s/{office365_id}/import/users
Lists Office 365 users available for import.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| top | query | optional | integer | Office 365 API maximum number of results per page. See https://docs.microsoft.com/en-us/graph/paging. |
| skipToken | query | optional | string | Office 365 API token used to access the next page of results. See https://docs.microsoft.com/en-us/graph/paging. |
| filter | query | optional | string | Office 365 API filter parameter. See https://docs.microsoft.com/en-us/graph/api/user-list?view=graph-rest-1.0&tabs=http#optional-query-parameters. |
| search | query | optional | string | Office 365 API search parameter. See https://docs.microsoft.com/en-us/graph/api/user-list?view=graph-rest-1.0&tabs=http#optional-query-parameters. |
| orderby | query | optional | string | Office 365 API orderby parameter. See https://docs.microsoft.com/en-us/graph/api/user-list?view=graph-rest-1.0&tabs=http#optional-query-parameters. |
| count | query | optional | boolean | Office 365 API count parameter. See https://docs.microsoft.com/en-us/graph/api/user-list?view=graph-rest-1.0&tabs=http#optional-query-parameters. |
GET /office365s/{office365_id}/import/users
/organizations/cases
This endpoint returns the cases (Support/Feature requests) for the organization
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /organizations/cases
/passwordmanager/devices
List Devices
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | |
| skip | query | optional | integer | |
| sort | query | optional | string | |
| fields | query | optional | array | |
| filter | query | optional | array |
GET /passwordmanager/devices
/passwordmanager/devices/{UUID}
Get Device
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| UUID | path | required | string |
GET /passwordmanager/devices/{UUID}
/policies
This endpoint returns all policies. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /policies
/policies
This endpoint allows you to create a policy. Given the amount of configurable parameters required to create a Policy, we suggest you use the JumpCloud Admin Console to create new policies. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/policies \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ {Policy_Parameters} }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyCreateRequest"
}
}
}
}
POST /policies
/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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
DELETE /policies/{id}
/policies/{id}
This endpoint returns a specific policy. ###### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{PolicyID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /policies/{id}
/policies/{id}
This endpoint allows you to update a policy. Given the amount of configurable parameters required to update a Policy, we suggest you use the JumpCloud Admin Console to create new policies. ##### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/policies/59fced45c9118022172547ff \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ {Policy_Parameters} }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyUpdateRequest"
}
}
}
}
PUT /policies/{id}
/policies/{policy_id}/policyresults
This endpoint returns all policies results for a specific policy. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policyresults \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /policies/{policy_id}/policyresults
/policies/{policy_id}/policystatuses
This endpoint returns the latest policy results for a specific policy. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policystatuses \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /policies/{policy_id}/policystatuses
/policyresults
This endpoint returns all policy results for an organization. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policyresults \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /policyresults
/policyresults/{id}
This endpoint will return the policy results for a specific policy. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policyresults/{Policy_ID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /policyresults/{id}
/policygroups
This endpoint returns all Policy Groups. Available filter fields: - `name` - `disabled` - `type` #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policygroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /policygroups
/policygroups
This endpoint allows you to create a new Policy Group. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/policygroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "name": "{Group_Name}" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"$ref": "#/components/requestBodies/PolicyGroupData"
}
POST /policygroups
/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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
DELETE /policygroups/{id}
/policygroups/{id}
This endpoint returns the details of a Policy Group. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /policygroups/{id}
/policygroups/{id}
This endpoint allows you to do a full update of the Policy Group. #### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/policygroups/{Group_ID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "name": "group_update" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"$ref": "#/components/requestBodies/PolicyGroupData"
}
PUT /policygroups/{id}
/policytemplates
This endpoint returns all policy templates. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policytemplates \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /policytemplates
/policytemplates/{id}
This endpoint returns a specific policy template. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policytemplates/{Policy_Template_ID}\ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /policytemplates/{id}
/integrations/autotask/{UUID}
Removes a Autotask integration.
DELETE /integrations/autotask/{UUID}
/integrations/autotask/{UUID}
Retrieves configuration for given Autotask integration id. You must be associated to the provider the integration is tied to in order to use this api.
GET /integrations/autotask/{UUID}
/integrations/autotask/{UUID}
Update the Autotask integration configuration. A 422 Unprocessable Entity response means the server failed to validate with Autotask.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutotaskIntegrationPatchReq"
}
}
}
}
PATCH /integrations/autotask/{UUID}
/integrations/autotask/{UUID}/companies
Retrieves a list of Autotask companies for the given Autotask id. You must be associated to the same provider as the Autotask integration to use this endpoint.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /integrations/autotask/{UUID}/companies
/integrations/autotask/{UUID}/companytypes
Retrieves a list of user defined company types from Autotask for the given Autotask id.
GET /integrations/autotask/{UUID}/companytypes
/integrations/autotask/{UUID}/contracts
Retrieves a list of Autotask contracts for the given Autotask integration id. You must be associated to the same provider as the Autotask integration to use this endpoint.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /integrations/autotask/{UUID}/contracts
/integrations/autotask/{UUID}/contracts/fields
Retrieves a list of Autotask contract fields for the given Autotask integration id. You must be associated to the same provider as the Autotask integration to use this endpoint.
GET /integrations/autotask/{UUID}/contracts/fields
/integrations/autotask/{UUID}/contracts/services
Retrieves a list of Autotask contract services for the given Autotask integration id. You must be associated to the same provider as the Autotask integration to use this endpoint.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /integrations/autotask/{UUID}/contracts/services
/integrations/autotask/{UUID}/mappings
Retrieves the list of mappings for this Autotask integration. You must be associated to the same provider as the Autotask integration to use this api.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /integrations/autotask/{UUID}/mappings
/integrations/autotask/{UUID}/mappings
Create, edit, and/or delete mappings between Jumpcloud organizations and Autotask companies/contracts/services. You must be associated to the same provider as the Autotask integration to use this api.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutotaskMappingRequest"
}
}
}
}
PATCH /integrations/autotask/{UUID}/mappings
/integrations/autotask/{UUID}/settings
Retrieve the Autotask integration settings. You must be associated to the same provider as the Autotask integration to use this endpoint.
GET /integrations/autotask/{UUID}/settings
/integrations/autotask/{UUID}/settings
Create, edit, and/or delete Autotask settings. You must be associated to the same provider as the Autotask integration to use this endpoint.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutotaskSettingsPatchReq"
}
}
}
}
PATCH /integrations/autotask/{UUID}/settings
/integrations/connectwise/{UUID}
Removes a ConnectWise integration.
DELETE /integrations/connectwise/{UUID}
/integrations/connectwise/{UUID}
Retrieves configuration for given ConnectWise integration id. You must be associated to the provider the integration is tied to in order to use this api.
GET /integrations/connectwise/{UUID}
/integrations/connectwise/{UUID}
Update the ConnectWise integration configuration. A 422 Unprocessable Entity response means the server failed to validate with ConnectWise.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectwiseIntegrationPatchReq"
}
}
}
}
PATCH /integrations/connectwise/{UUID}
/integrations/connectwise/{UUID}/agreements
Retrieves a list of ConnectWise agreements for the given ConnectWise id. You must be associated to the same provider as the ConnectWise integration to use this endpoint.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /integrations/connectwise/{UUID}/agreements
/integrations/connectwise/{UUID}/agreements/{agreement_ID}/additions
Retrieves a list of ConnectWise additions for the given ConnectWise id and Agreement id. You must be associated to the same provider as the ConnectWise integration to use this endpoint.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /integrations/connectwise/{UUID}/agreements/{agreement_ID}/additions
/integrations/connectwise/{UUID}/companies
Retrieves a list of ConnectWise companies for the given ConnectWise id. You must be associated to the same provider as the ConnectWise integration to use this endpoint.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /integrations/connectwise/{UUID}/companies
/integrations/connectwise/{UUID}/companytypes
Retrieves a list of user defined company types from ConnectWise for the given ConnectWise id.
GET /integrations/connectwise/{UUID}/companytypes
/integrations/connectwise/{UUID}/mappings
Retrieves the list of mappings for this ConnectWise integration. You must be associated to the same provider as the ConnectWise integration to use this api.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /integrations/connectwise/{UUID}/mappings
/integrations/connectwise/{UUID}/mappings
Create, edit, and/or delete mappings between Jumpcloud organizations and ConnectWise companies/agreements/additions. You must be associated to the same provider as the ConnectWise integration to use this api.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectWiseMappingRequest"
}
}
}
}
PATCH /integrations/connectwise/{UUID}/mappings
/integrations/connectwise/{UUID}/settings
Retrieve the ConnectWise integration settings. You must be associated to the same provider as the ConnectWise integration to use this endpoint.
GET /integrations/connectwise/{UUID}/settings
/integrations/connectwise/{UUID}/settings
Create, edit, and/or delete ConnectWiseIntegration settings. You must be associated to the same provider as the ConnectWise integration to use this endpoint.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectWiseSettingsPatchReq"
}
}
}
}
PATCH /integrations/connectwise/{UUID}/settings
/integrations/syncro/{UUID}
Removes a Syncro integration.
DELETE /integrations/syncro/{UUID}
/integrations/syncro/{UUID}
Retrieves configuration for given Syncro integration id. You must be associated to the provider the integration is tied to in order to use this api.
GET /integrations/syncro/{UUID}
/integrations/syncro/{UUID}
Update the Syncro integration configuration. A 422 Unprocessable Entity response means the server failed to validate with Syncro.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SyncroIntegrationPatchReq"
}
}
}
}
PATCH /integrations/syncro/{UUID}
/integrations/syncro/{UUID}/billing_mapping_configuration_options
Retrieves a list of dependencies for Syncro billing mappings.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /integrations/syncro/{UUID}/billing_mapping_configuration_options
/integrations/syncro/{UUID}/companies
Retrieves a list of Syncro companies for the given Syncro id. You must be associated to the same provider as the Syncro integration to use this endpoint.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /integrations/syncro/{UUID}/companies
/integrations/syncro/{UUID}/mappings
Retrieves the list of mappings for this Syncro integration. You must be associated to the same provider as the Syncro integration to use this api.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /integrations/syncro/{UUID}/mappings
/integrations/syncro/{UUID}/mappings
Create, edit, and/or delete mappings between Jumpcloud organizations and Syncro companies. You must be associated to the same provider as the Syncro integration to use this api.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SyncroMappingRequest"
}
}
}
}
PATCH /integrations/syncro/{UUID}/mappings
/integrations/syncro/{UUID}/settings
Retrieve the Syncro integration settings. You must be associated to the same provider as the Syncro integration to use this endpoint.
GET /integrations/syncro/{UUID}/settings
/integrations/syncro/{UUID}/settings
Create, edit, and/or delete SyncroIntegration settings. You must be associated to the same provider as the Syncro integration to use this endpoint.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SyncroSettingsPatchReq"
}
}
}
}
PATCH /integrations/syncro/{UUID}/settings
/integrations/{integration_type}/{UUID}/errors
Retrieves recent sync errors for given integration type and integration id. You must be associated to the provider the integration is tied to in order to use this api.
GET /integrations/{integration_type}/{UUID}/errors
/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.
DELETE /providers/{provider_id}/administrators/{id}
/providers/{provider_id}/billing/contract
Retrieve contract for a Provider
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| provider_id | path | required | string |
GET /providers/{provider_id}/billing/contract
/providers/{provider_id}/billing/details
Retrieve billing details for a Provider
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| provider_id | path | required | string |
GET /providers/{provider_id}/billing/details
/providers/{provider_id}/integrations
Retrieves a list of integrations this provider has configured. You must be associated to the provider to use this endpoint.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /providers/{provider_id}/integrations
/providers/{provider_id}/integrations/autotask
Creates a new Autotask integration for the provider. You must be associated with the provider to use this route. A 422 Unprocessable Entity response means the server failed to validate with Autotask.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutotaskIntegrationReq"
}
}
}
}
POST /providers/{provider_id}/integrations/autotask
/providers/{provider_id}/integrations/autotask/alerts/configuration
Get all Autotask ticketing alert configurations for a provider.
GET /providers/{provider_id}/integrations/autotask/alerts/configuration
/providers/{provider_id}/integrations/autotask/alerts/configuration/options
Get all Autotask ticketing alert configuration options for a provider.
GET /providers/{provider_id}/integrations/autotask/alerts/configuration/options
/providers/{provider_id}/integrations/autotask/alerts/{alert_UUID}/configuration
Update an Autotask ticketing alert's configuration
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutotaskTicketingAlertConfigurationRequest"
}
}
}
}
PUT /providers/{provider_id}/integrations/autotask/alerts/{alert_UUID}/configuration
/providers/{provider_id}/integrations/connectwise
Creates a new ConnectWise integration for the provider. You must be associated with the provider to use this route. A 422 Unprocessable Entity response means the server failed to validate with ConnectWise.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectwiseIntegrationReq"
}
}
}
}
POST /providers/{provider_id}/integrations/connectwise
/providers/{provider_id}/integrations/connectwise/alerts/configuration
Get all ConnectWise ticketing alert configurations for a provider.
GET /providers/{provider_id}/integrations/connectwise/alerts/configuration
/providers/{provider_id}/integrations/connectwise/alerts/configuration/options
Get all ConnectWise ticketing alert configuration options for a provider.
GET /providers/{provider_id}/integrations/connectwise/alerts/configuration/options
/providers/{provider_id}/integrations/connectwise/alerts/{alert_UUID}/configuration
Update a ConnectWise ticketing alert's configuration.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectWiseTicketingAlertConfigurationRequest"
}
}
}
}
PUT /providers/{provider_id}/integrations/connectwise/alerts/{alert_UUID}/configuration
/providers/{provider_id}/integrations/syncro
Creates a new Syncro integration for the provider. You must be associated with the provider to use this route. A 422 Unprocessable Entity response means the server failed to validate with Syncro.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SyncroIntegrationReq"
}
}
}
}
POST /providers/{provider_id}/integrations/syncro
/providers/{provider_id}/integrations/syncro/alerts/configuration
Get all Syncro ticketing alert configurations for a provider.
GET /providers/{provider_id}/integrations/syncro/alerts/configuration
/providers/{provider_id}/integrations/syncro/alerts/configuration/options
Get all Syncro ticketing alert configuration options for a provider.
GET /providers/{provider_id}/integrations/syncro/alerts/configuration/options
/providers/{provider_id}/integrations/syncro/alerts/{alert_UUID}/configuration
Update a Syncro ticketing alert's configuration
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SyncroTicketingAlertConfigurationRequest"
}
}
}
}
PUT /providers/{provider_id}/integrations/syncro/alerts/{alert_UUID}/configuration
/providers/{provider_id}/integrations/ticketing/alerts
Get all ticketing alerts available for a provider's ticketing integration.
GET /providers/{provider_id}/integrations/ticketing/alerts
/cases/metadata
This endpoint returns the metadata for cases
GET /cases/metadata
/providers/{provider_id}
This endpoint returns details about a provider
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /providers/{provider_id}
/providers/{provider_id}/administrators
This endpoint returns a list of the Administrators associated with the Provider. You must be associated with the provider to use this route.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /providers/{provider_id}/administrators
/providers/{provider_id}/administrators
This endpoint allows you to create a provider administrator. You must be associated with the provider to use this route. You must provide either `role` or `roleName`.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderAdminReq"
}
}
}
}
POST /providers/{provider_id}/administrators
/providers/{provider_id}/cases
This endpoint returns the cases (Support/Feature requests) for the provider
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /providers/{provider_id}/cases
/providers/{provider_id}/invoices
Retrieves a list of invoices for this provider. You must be associated to the provider to use this endpoint.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /providers/{provider_id}/invoices
/providers/{provider_id}/invoices/{ID}
Retrieves an invoice for this provider. You must be associated to the provider to use this endpoint.
GET /providers/{provider_id}/invoices/{ID}
/providers/{provider_id}/organizations
This endpoint returns a list of the Organizations associated with the Provider. You must be associated with the provider to use this route.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /providers/{provider_id}/organizations
/providers/{provider_id}/organizations
This endpoint creates a new organization under the provider
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOrganization"
}
}
}
}
POST /providers/{provider_id}/organizations
/providers/{provider_id}/organizations/{id}
This endpoint updates a provider's organization
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Organization"
}
}
}
}
PUT /providers/{provider_id}/organizations/{id}
/providers/{provider_id}/configuredpolicytemplates
Retrieves a list of Configured Policy Templates for this provider.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /providers/{provider_id}/configuredpolicytemplates
/providers/{provider_id}/configuredpolicytemplates/{id}
Retrieves a Configured Policy Templates for this provider and Id.
GET /providers/{provider_id}/configuredpolicytemplates/{id}
/providers/{provider_id}/policygrouptemplates
Retrieves a list of Policy Group Templates for this provider.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /providers/{provider_id}/policygrouptemplates
/providers/{provider_id}/policygrouptemplates/{id}
Deletes a Policy Group Template.
DELETE /providers/{provider_id}/policygrouptemplates/{id}
/providers/{provider_id}/policygrouptemplates/{id}
Retrieves a Policy Group Template for this provider.
GET /providers/{provider_id}/policygrouptemplates/{id}
/providers/{provider_id}/policygrouptemplates/{id}/members
Retrieves a Policy Group Template's Members.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /providers/{provider_id}/policygrouptemplates/{id}/members
/pushendpoints/verifications/{verificationId}
Endpoint for retrieving a verification push notification status
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| verificationId | path | required | string |
GET /pushendpoints/verifications/{verificationId}
/users/{userId}/pushendpoints/{pushEndpointId}/verify
Endpoint for sending a verification push notification
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| userId | path | required | string | |
| pushEndpointId | path | required | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PushVerificationsStartRequest"
}
}
},
"required": true
}
POST /users/{userId}/pushendpoints/{pushEndpointId}/verify
/ldapservers/{ldapserver_id}/sambadomains
This endpoint returns all samba domains for an LDAP server. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /ldapservers/{ldapserver_id}/sambadomains
/ldapservers/{ldapserver_id}/sambadomains
This endpoint allows you to create a samba domain for an LDAP server. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "sid":"{SID_ID}", "name":"{WORKGROUP_NAME}" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"$ref": "#/components/requestBodies/samba-domain"
}
POST /ldapservers/{ldapserver_id}/sambadomains
/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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
DELETE /ldapservers/{ldapserver_id}/sambadomains/{id}
/ldapservers/{ldapserver_id}/sambadomains/{id}
This endpoint returns a specific samba domain for an LDAP server. ##### Sample Request ``` curl -X GET \ https://console.jumpcloud.com/api/v2/ldapservers/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /ldapservers/{ldapserver_id}/sambadomains/{id}
/ldapservers/{ldapserver_id}/sambadomains/{id}
This endpoint allows you to update the samba domain information for an LDAP server. ##### Sample Request ``` curl -X PUT 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}' \ -d '{ "sid":"{SID_ID}", "name":"{WORKGROUP_NAME}" }' ```
{
"$ref": "#/components/requestBodies/samba-domain"
}
PUT /ldapservers/{ldapserver_id}/sambadomains/{id}
/softwareapps
This endpoint allows you to get all configured Software Applications that will be managed by JumpCloud on associated JumpCloud systems. The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. #### Sample Request ``` $ curl -X GET https://console.jumpcloud.com/api/v2/softwareapps \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /softwareapps
/softwareapps
This endpoint allows you to create a Software Application that will be managed by JumpCloud on associated JumpCloud systems. The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. #### Sample Request ``` $ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "displayName": "Adobe Reader", "settings": [{"packageId": "adobereader"}] }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/software-app"
}
}
}
}
POST /softwareapps
/softwareapps/validate
Validates an application install package from the specified URL to calculate the SHA256 hash and extract the installer manifest details. #### Sample Request ``` curl -H 'x-api-key: {API_KEY}' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -d '{"url": "https://dl.google.com/dl/chrome/mac/universal/stable/gcem/GoogleChrome.pkg"}' \ -i -X POST https://console.jumpcloud.com/api/v2/softwareapps/validate ```
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/jumpcloud.package_validator.ValidateApplicationInstallPackageRequest"
}
}
},
"required": true
}
POST /softwareapps/validate
/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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
DELETE /softwareapps/{id}
/softwareapps/{id}
Retrieves a Software Application. The optional isConfigEnabled and appConfiguration apple_vpp attributes are populated in this response. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{id} \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /softwareapps/{id}
/softwareapps/{id}
This endpoint updates a specific Software Application configuration for the organization. displayName can be changed alone if no settings are provided. If a setting is provided, it should include all its information since this endpoint will update all the settings' fields. The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. #### Sample Request - displayName only ``` curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "displayName": "My Software App" }' ``` #### Sample Request - all attributes ``` curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "displayName": "My Software App", "settings": [ { "packageId": "123456", "autoUpdate": false, "allowUpdateDelay": false, "packageManager": "APPLE_VPP", "locationObjectId": "123456789012123456789012", "location": "123456", "desiredState": "Install", "appleVpp": { "appConfiguration": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\"><plist version=\"1.0\"><dict><key>MyKey</key><string>My String</string></dict></plist>", "assignedLicenses": 20, "availableLicenses": 10, "details": {}, "isConfigEnabled": true, "supportedDeviceFamilies": [ "IPAD", "MAC" ], "totalLicenses": 30 }, "packageSubtitle": "My package subtitle", "packageVersion": "1.2.3", "packageKind": "software-package", "assetKind": "software", "assetSha256Size": 256, "assetSha256Strings": [ "a123b123c123d123" ], "description": "My app description" } ] }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/software-app"
}
}
},
"x-examples": {
"all-attributes": {
"settings": [
{
"appleVpp": {
"details": {},
"totalLicenses": 30,
"isConfigEnabled": true,
"appConfiguration": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\"><plist version=\"1.0\"><dict><key>MyKey</key><string>My String</string></dict></plist>",
"assignedLicenses": 20,
"availableLicenses": 10,
"supportedDeviceFamilies": [
"IPAD",
"MAC"
]
},
"location": "123456",
"assetKind": "software",
"packageId": "123456",
"autoUpdate": false,
"description": "My app description",
"packageKind": "software-package",
"desiredState": "Install",
"packageManager": "APPLE_VPP",
"packageVersion": "1.2.3",
"assetSha256Size": 256,
"packageSubtitle": "My package subtitle",
"allowUpdateDelay": false,
"locationObjectId": "123456789012123456789012",
"assetSha256Strings": [
"a123b123c123d123"
]
}
],
"displayName": "My Software App"
},
"displayName-only": {
"displayName": "My Software App"
}
}
}
PUT /softwareapps/{id}
/softwareapps/{software_app_id}/reclaim-licenses
This endpoint allows you to reclaim the licenses from a software app associated with devices that are deleted. #### Sample Request ``` $ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/reclaim-licenses \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{}' ```
POST /softwareapps/{software_app_id}/reclaim-licenses
/softwareapps/{software_app_id}/retry-installation
This endpoints initiates an installation retry of an Apple VPP App for the provided system IDs #### Sample Request ``` $ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/retry-installation \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{"system_ids": "{<system_id_1>, <system_id_2>, ...}"}' ```
POST /softwareapps/{software_app_id}/retry-installation
/softwareapps/{software_app_id}/statuses
This endpoint allows you to get the status of the provided Software Application on associated JumpCloud systems. #### Sample Request ``` $ curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/statuses \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /softwareapps/{software_app_id}/statuses
/subscriptions
This endpoint returns all pricing & packaging subscriptions. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/subscriptions \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
GET /subscriptions
/systemgroups
This endpoint returns all System Groups. Available filter fields: - `name` - `disabled` - `type` - `membershipMethod` #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systemgroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systemgroups
/systemgroups
This endpoint allows you to create a new System Group. See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/systemgroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "name": "{Group_Name}" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemGroupPost"
}
}
}
}
POST /systemgroups
/systemgroups/{group_id}/suggestions
This endpoint returns available suggestions for a given system group #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/suggestions \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| group_id | path | required | string | ID of the group |
GET /systemgroups/{group_id}/suggestions
/systemgroups/{group_id}/suggestions
This endpoint applies the suggestions for the specified system group. #### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/suggestions \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "object_ids": ["212345678901234567890123", "123456789012345678901234"] }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| group_id | path | required | string | ID of the group |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemGroupsApplySuggestionsRequest"
}
}
},
"required": true
}
POST /systemgroups/{group_id}/suggestions
/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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
DELETE /systemgroups/{id}
/systemgroups/{id}
This endpoint returns the details of a System Group. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /systemgroups/{id}
/systemgroups/{id}
This endpoint allows you to do a full update of the System Group. See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. #### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "name": "Name_Update" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemGroupPut"
}
}
}
}
PUT /systemgroups/{id}
/systeminsights/alf
Valid filter fields are `system_id` and `global_state`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/alf
/systeminsights/alf_exceptions
Valid filter fields are `system_id` and `state`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/alf_exceptions
/systeminsights/alf_explicit_auths
Valid filter fields are `system_id` and `process`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/alf_explicit_auths
/systeminsights/appcompat_shims
Valid filter fields are `system_id` and `enabled`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/appcompat_shims
/systeminsights/apps
Lists all apps for macOS devices. For Windows devices, use [List System Insights Programs](https://docs.jumpcloud.com). Valid filter fields are `system_id` and `bundle_name`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/apps
/systeminsights/authorized_keys
Valid filter fields are `system_id` and `uid`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/authorized_keys
/systeminsights/azure_instance_metadata
Valid filter fields are `system_id`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/azure_instance_metadata
/systeminsights/azure_instance_tags
Valid filter fields are `system_id`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/azure_instance_tags
/systeminsights/battery
Valid filter fields are `system_id` and `health`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/battery
/systeminsights/bitlocker_info
Valid filter fields are `system_id` and `protection_status`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/bitlocker_info
/systeminsights/browser_plugins
Valid filter fields are `system_id` and `name`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/browser_plugins
/systeminsights/certificates
Valid filter fields are `system_id` and `common_name`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/certificates
/systeminsights/chassis_info
Valid filter fields are `system_id`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/chassis_info
/systeminsights/chrome_extensions
Valid filter fields are `system_id` and `name`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/chrome_extensions
/systeminsights/connectivity
The only valid filter field is `system_id`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/connectivity
/systeminsights/crashes
Valid filter fields are `system_id` and `identifier`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/crashes
/systeminsights/cups_destinations
Valid filter fields are `system_id` and `name`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/cups_destinations
/systeminsights/disk_encryption
Valid filter fields are `system_id` and `encryption_status`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/disk_encryption
/systeminsights/disk_info
Valid filter fields are `system_id` and `disk_index`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/disk_info
/systeminsights/dns_resolvers
Valid filter fields are `system_id` and `type`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/dns_resolvers
/systeminsights/etc_hosts
Valid filter fields are `system_id` and `address`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/etc_hosts
/systeminsights/firefox_addons
Valid filter fields are `system_id` and `name`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/firefox_addons
/systeminsights/groups
Valid filter fields are `system_id` and `groupname`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/groups
/systeminsights/ie_extensions
Valid filter fields are `system_id` and `name`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/ie_extensions
/systeminsights/interface_addresses
Valid filter fields are `system_id` and `address`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/interface_addresses
/systeminsights/interface_details
Valid filter fields are `system_id` and `interface`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/interface_details
/systeminsights/kernel_info
Valid filter fields are `system_id` and `version`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/kernel_info
/systeminsights/launchd
Valid filter fields are `system_id` and `name`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/launchd
/systeminsights/linux_packages
Lists all programs for Linux devices. For macOS devices, use [List System Insights System Apps](https://docs.jumpcloud.com). For windows devices, use [List System Insights System Apps](https://docs.jumpcloud.com). Valid filter fields are `name` and `package_format`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/linux_packages
/systeminsights/logged_in_users
Valid filter fields are `system_id` and `user`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/logged_in_users
/systeminsights/logical_drives
Valid filter fields are `system_id` and `device_id`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/logical_drives
/systeminsights/managed_policies
Valid filter fields are `system_id` and `domain`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/managed_policies
/systeminsights/mounts
Valid filter fields are `system_id` and `path`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/mounts
/systeminsights/os_version
Valid filter fields are `system_id` and `version`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/os_version
/systeminsights/patches
Valid filter fields are `system_id` and `hotfix_id`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/patches
/systeminsights/programs
Lists all programs for Windows devices. For macOS devices, use [List System Insights Apps](https://docs.jumpcloud.com). Valid filter fields are `system_id` and `name`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/programs
/systeminsights/python_packages
Valid filter fields are `system_id` and `name`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/python_packages
/systeminsights/safari_extensions
Valid filter fields are `system_id` and `name`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/safari_extensions
/systeminsights/scheduled_tasks
Valid filter fields are `system_id` and `enabled`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/scheduled_tasks
/systeminsights/secureboot
Valid filter fields are `system_id`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/secureboot
/systeminsights/services
Valid filter fields are `system_id` and `name`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/services
/systeminsights/shadow
Valid filter fields are `system_id` and `username`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/shadow
/systeminsights/shared_folders
Valid filter fields are `system_id` and `name`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/shared_folders
/systeminsights/shared_resources
Valid filter fields are `system_id` and `type`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/shared_resources
/systeminsights/sharing_preferences
Only valid filed field is `system_id`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/sharing_preferences
/systeminsights/sip_config
Valid filter fields are `system_id` and `enabled`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/sip_config
/systeminsights/startup_items
Valid filter fields are `system_id` and `name`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/startup_items
/systeminsights/system_controls
Valid filter fields are `system_id` and `name`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/system_controls
/systeminsights/system_info
Valid filter fields are `system_id` and `cpu_subtype`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/system_info
/systeminsights/tpm_info
Valid filter fields are `system_id`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/tpm_info
/systeminsights/uptime
Valid filter fields are `system_id` and `days`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/uptime
/systeminsights/usb_devices
Valid filter fields are `system_id` and `model`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/usb_devices
/systeminsights/user_groups
Only valid filter field is `system_id`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/user_groups
/systeminsights/user_ssh_keys
Valid filter fields are `system_id` and `uid`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/user_ssh_keys
/systeminsights/userassist
Valid filter fields are `system_id`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/userassist
/systeminsights/users
Valid filter fields are `system_id` and `username`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/users
/systeminsights/wifi_networks
Valid filter fields are `system_id` and `security_type`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/wifi_networks
/systeminsights/wifi_status
Valid filter fields are `system_id` and `security_type`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/wifi_status
/systeminsights/windows_security_center
Valid filter fields are `system_id`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/windows_security_center
/systeminsights/windows_security_products
Valid filter fields are `system_id` and `state`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systeminsights/windows_security_products
/accessrequests
Endpoint for adding a new access request
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/jumpcloud.ingresso.CreateAccessRequestsRequest"
}
}
},
"required": true
}
POST /accessrequests
/accessrequests/{accessId}
Endpoint for getting all access requests by access id
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| accessId | path | required | string |
GET /accessrequests/{accessId}
/accessrequests/{accessId}
Endpoint for updating access request by id
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| accessId | path | required | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessRequestApiUpdateAccessRequestRequest"
}
}
},
"required": true
}
PUT /accessrequests/{accessId}
/accessrequests/{accessId}/revoke
Endpoint for revoking access request by id
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| accessId | path | required | string |
POST /accessrequests/{accessId}/revoke
/systems/{system_id}/softwareappstatuses
This endpoint returns all the statuses of the associated Software Applications from the provided JumpCloud system ID. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{system_id}/softwareappstatuses \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /systems/{system_id}/softwareappstatuses
/systems/{system_id}/fdekey
This endpoint will return the current (latest) fde key saved for a system.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /systems/{system_id}/fdekey
/devices/settings/defaultpasswordsync
Gets the Default Password Sync Setting for an Organization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organizationObjectId | query | optional | string |
GET /devices/settings/defaultpasswordsync
/devices/settings/defaultpasswordsync
Sets the Default Password Sync Setting for an Organization.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/devices.SetDefaultPasswordSyncSettingsRequest"
}
}
},
"required": true
}
PUT /devices/settings/defaultpasswordsync
/devices/settings/signinwithjumpcloud
Gets the Sign In with JumpCloud Settings for an Organization. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/devices/settings/signinwithjumpcloud \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key:{API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organizationObjectId | query | optional | string |
GET /devices/settings/signinwithjumpcloud
/devices/settings/signinwithjumpcloud
Sets the Sign In with JumpCloud Settings for an Organization. #### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/devices/settings/signinwithjumpcloud \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key:{API_KEY}' \ -d '{"settings":[{"osFamily":"WINDOWS","enabled":true,"defaultPermission":"STANDARD"}]}' ```
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/devices.SetSignInWithJumpCloudSettingsRequest"
}
}
},
"required": true
}
PUT /devices/settings/signinwithjumpcloud
/usergroups
This endpoint returns all User Groups. Available filter fields: - `name` - `disabled` - `type` - `membershipMethod` - `suggestionCounts.add` - `suggestionCounts.remove` - `suggestionCounts.total` - `attributes.sudo.enabled` - `attributes.sudo.withoutPassword` #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /usergroups
/usergroups
This endpoint allows you to create a new User Group. See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/usergroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "name": "{Group_Name}" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserGroupPost"
}
}
}
}
POST /usergroups
/usergroups/{group_id}/suggestions
This endpoint returns available suggestions for a given group #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/suggestions \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| group_id | path | required | string | ID of the group |
GET /usergroups/{group_id}/suggestions
/usergroups/{group_id}/suggestions
This endpoint applies the suggestions for the specified user group. #### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/suggestions \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "user_ids": ["212345678901234567890123", "123456789012345678901234"] }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| group_id | path | required | string | ID of the group |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserGroupsApplySuggestionsRequest"
}
}
},
"required": true
}
POST /usergroups/{group_id}/suggestions
/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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
DELETE /usergroups/{id}
/usergroups/{id}
This endpoint returns the details of a User Group. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /usergroups/{id}
/usergroups/{id}
This endpoint allows you to do a full update of the User Group. See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. #### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "name": "group_update" }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserGroupPut"
}
}
}
}
PUT /usergroups/{id}
/users/{user_id}/pushendpoints
This endpoint returns the list of push endpoints associated with a user. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/pushendpoints \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: ${API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /users/{user_id}/pushendpoints
/users/{user_id}/pushendpoints/{push_endpoint_id}
This endpoint will delete a push endpoint associated with a user.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
DELETE /users/{user_id}/pushendpoints/{push_endpoint_id}
/users/{user_id}/pushendpoints/{push_endpoint_id}
This endpoint will retrieve a push endpoint associated with a user.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /users/{user_id}/pushendpoints/{push_endpoint_id}
/users/{user_id}/pushendpoints/{push_endpoint_id}
This endpoint will update a push endpoint associated with a user.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PushEndpointsPatchRequest"
}
}
}
}
PATCH /users/{user_id}/pushendpoints/{push_endpoint_id}
/workdays
This endpoint will return all the available information about all your instances of Workday. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/workdays/ \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /workdays
/workdays
This endpoint allows you to create a new workday instance. You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. Failure to provide these credentials will result in the request being rejected. Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. Currently, only one instance is allowed and it must be `Workday Import`. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/workdays/ \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "name": "Workday2", "reportUrl":"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json", "auth": { "basic": { "username": "someDeveloper", "password": "notTheRealPassword" } } }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/workday-input"
}
}
}
}
POST /workdays
/workdays/{id}
This endpoint will return all the available information about an instance of Workday. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/workdays/ \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
GET /workdays/{id}
/workdays/{id}
This endpoint allows you to update the name and Custom Report URL for a Workday Instance. Currently, the name can not be changed from the default of `Workday Import`. ##### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/workdays/{WorkdayID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "reportUrl":"{Report_URL}", "name":"{Name}" } ' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/workday-fields"
}
}
}
}
PUT /workdays/{id}
/workdays/{id}/import/{job_id}/results
This endpoint provides a list of job results from the workday import and will contain all imported data from Workday. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import/{ImportJobID}/results \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional |
GET /workdays/{id}/import/{job_id}/results
/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}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
DELETE /workdays/{workday_id}/auth
/workdays/{workday_id}/auth
This endpoint adds an authorization method to a workday instance. You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. Failure to provide these credentials will result in the request being rejected. Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "auth":{ "basic": { "username": "someDeveloper", "password": "notTheRealPassword" } } }' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/auth-input-object"
}
}
}
}
POST /workdays/{workday_id}/auth
/workdays/{workday_id}/import
The endpoint allows you to create a Workday Import request. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import \ -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":"WorkdayID","value":"name.name"} ] } ] ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"$ref": "#/components/requestBodies/bulk-user-createArray"
}
POST /workdays/{workday_id}/import
/workdays/{workday_id}/workers
This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /workdays/{workday_id}/workers
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."
}
}
}
ADES
{
"type": "object",
"title": "ADES",
"properties": {
"ios": {
"$ref": "#/components/schemas/ADE"
},
"macos": {
"$ref": "#/components/schemas/ADE"
}
}
}
AccessRequestApiRevokeAccessRequestResponse
{
"type": "object",
"example": {},
"properties": {}
}
AccessRequestApiUpdateAccessRequestRequest
{
"type": "object",
"properties": {
"expiry": {
"type": "string",
"format": "date-time"
},
"remarks": {
"type": "string"
},
"additionalAttributes": {
"type": "object"
},
"organizationObjectId": {
"type": "string",
"format": "byte"
}
}
}
AccessRequestApiUpdateAccessRequestResponse
{
"type": "object",
"example": {},
"properties": {}
}
ActivedirectoriesAgentsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/active-directory-agent-list"
}
}
ActivedirectoriesListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/active-directory"
}
}
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
}
}
}
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"
}
}
}
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"
}
}
}
AdministratorOrganizationLinkReq
{
"type": "object",
"title": "AdministratorOrganizationLinkReq",
"example": {
"organization": "6230a0d26a4e4bc86c6b36f1"
},
"properties": {
"organization": {
"type": "string",
"description": "The identifier for an organization to link this administrator to."
}
}
}
AdministratorOrganizationsListByAdministratorResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AdministratorOrganizationLink"
}
}
AdministratorOrganizationsListByOrganizationResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AdministratorOrganizationLink"
}
}
AnyValue
{
"description": "Can be any value - string, number, boolean, array or 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."
}
}
}
ApplemdmsDevicesClearActivationLock500Response
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ApplemdmsDevicesClearActivationLockResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ApplemdmsDevicesOsUpdateStatusResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ApplemdmsDevicesRefreshActivationLockInformation500Response
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ApplemdmsDevicesRefreshActivationLockInformationResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ApplemdmsDevicesScheduleOsUpdateResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ApplemdmsDeviceserase500Response
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ApplemdmsDeviceseraseRequest
{
"type": "object",
"properties": {
"pin": {
"type": "string",
"example": "123456",
"pattern": "^[0-9]{6}$",
"description": "6-digit PIN, required for MacOS, to erase the device"
}
}
}
ApplemdmsDeviceseraseResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ApplemdmsDeviceslistResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/apple-mdm-device"
}
}
ApplemdmsDeviceslock500Response
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ApplemdmsDeviceslockRequest
{
"type": "object",
"properties": {
"pin": {
"type": "string",
"example": "123456",
"pattern": "^[0-9]{6}$",
"description": "6-digit PIN, required for MacOS, to lock the device"
}
}
}
ApplemdmsDeviceslockResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ApplemdmsDevicesrestart500Response
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ApplemdmsDevicesrestartRequest
{
"type": "object",
"properties": {
"kextPaths": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string to pass when doing a restart and performing a RebuildKernelCache."
}
}
}
ApplemdmsDevicesrestartResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ApplemdmsDevicesshutdown500Response
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ApplemdmsDevicesshutdownResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ApplemdmsEnrollmentprofileslistResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AppleMDM"
}
}
ApplemdmsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AppleMDM"
}
}
ApplemdmsRefreshdepdevices500Response
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ApplemdmsRefreshdepdevicesResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ApplicationsGetResponse
{
"type": "object",
"example": {},
"properties": {}
}
ApplicationsPostLogoRequest
{
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary",
"description": "The file to upload."
}
}
}
Apps
{
"type": "array",
"items": {
"type": "object",
"properties": {
"osId": {
"type": "integer",
"format": "int32",
"example": 1
},
"appVersion": {
"type": "string",
"example": "1.1.1"
}
}
}
}
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."
}
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
}
}
}
}
}
AuthnPolicyObligations
{
"type": "object",
"title": "AuthnPolicyObligations",
"properties": {
"mfa": {
"type": "object",
"properties": {
"required": {
"type": "boolean"
}
}
},
"userVerification": {
"type": "object",
"properties": {
"requirement": {
"enum": [
"none",
"optional",
"required"
],
"type": "string"
}
}
}
}
}
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"
}
}
}
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"
}
}
}
AuthnPolicyType
{
"enum": [
"user_portal",
"application",
"ldap"
],
"type": "string",
"title": "AuthnPolicyType",
"default": "user_portal"
}
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"
}
}
}
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."
}
AuthnPolicyUserGroupTarget
{
"type": "object",
"title": "AuthnPolicyUserGroupTarget",
"properties": {
"exclusions": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusions": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
AuthnPolicyUserTarget
{
"type": "object",
"title": "AuthnPolicyUserTarget",
"properties": {
"inclusions": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
AuthnpoliciesListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthnPolicy"
}
}
AutotaskCompany
{
"type": "object",
"title": "AutotaskCompany",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"description": "The autotask company identifier."
},
"name": {
"type": "string",
"description": "The autotask company name."
}
},
"description": "Autotask company details"
}
AutotaskCompanyResp
{
"type": "object",
"title": "AutotaskCompanyResp",
"required": [
"totalCount",
"records"
],
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutotaskCompany"
}
},
"totalCount": {
"type": "integer"
}
},
"description": "Response for retrieving Autotask companies"
}
AutotaskCompanyTypeResp
{
"type": "object",
"required": [
"totalCount",
"records"
],
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillingIntegrationCompanyType"
}
},
"totalCount": {
"type": "integer"
}
},
"description": "Response for retrieving Autotask company types"
}
AutotaskContract
{
"type": "object",
"title": "AutotaskContract",
"required": [
"id",
"name",
"companyId"
],
"properties": {
"id": {
"type": "string",
"description": "The contract identifier."
},
"name": {
"type": "string",
"description": "The contract name."
},
"companyId": {
"type": "string",
"description": "The Autotask company identifier linked to contract."
}
},
"description": "Autotask contract details"
}
AutotaskContractField
{
"type": "object",
"title": "AutotaskContractField",
"required": [
"name",
"values"
],
"properties": {
"name": {
"type": "string",
"description": "The contract field name."
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"description": "Autotask contract field details"
}
AutotaskCreateConfiguration422Response
{
"type": "object",
"properties": {}
}
AutotaskCreateConfigurationResponse
{
"type": "object",
"required": [
"integrationId"
],
"properties": {
"integrationId": {
"type": "string",
"description": "The identifier of the created integration"
}
}
}
AutotaskIntegration
{
"type": "object",
"title": "Get Autotask integration GET object",
"required": [
"id",
"username"
],
"properties": {
"id": {
"type": "string",
"description": "The identifier for this Autotask integration."
},
"username": {
"type": "string",
"description": "The username for connecting to Autotask."
},
"isMspAuthConfigured": {
"type": "boolean",
"description": "Has the msp-api been configured with auth data yet"
}
},
"description": "Autotask integration configuration details"
}
AutotaskIntegrationPatchReq
{
"type": "object",
"title": "Create Autotask Integration PATCH object",
"properties": {
"secret": {
"type": "string",
"description": "The secret for connecting to Autotask."
},
"username": {
"type": "string",
"description": "The username for connecting to Autotask."
}
},
"description": "Request for updating a Autotask integration"
}
AutotaskIntegrationReq
{
"type": "object",
"title": "Create Autotask Integration POST object",
"required": [
"username",
"secret"
],
"properties": {
"secret": {
"type": "string",
"description": "The secret for connecting to Autotask."
},
"username": {
"type": "string",
"description": "The username for connecting to Autotask."
}
},
"description": "Request for creating a Autotask integration"
}
AutotaskMappingRequest
{
"type": "object",
"title": "AutotaskMappingRequest",
"minItems": 1,
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"organization",
"company"
],
"properties": {
"delete": {
"type": "boolean"
},
"company": {
"$ref": "#/components/schemas/AutotaskMappingRequestCompany"
},
"service": {
"$ref": "#/components/schemas/AutotaskMappingRequestService"
},
"contract": {
"$ref": "#/components/schemas/AutotaskMappingRequestContract"
},
"organization": {
"$ref": "#/components/schemas/AutotaskMappingRequestOrganization"
}
}
}
}
},
"description": "Request object for creating Autotask mappings"
}
AutotaskMappingRequestCompany
{
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
AutotaskMappingRequestContract
{
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
}
}
AutotaskMappingRequestOrganization
{
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string"
}
}
}
AutotaskMappingRequestService
{
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"nonBillableUsers": {
"type": "integer",
"nullable": true
}
}
}
AutotaskMappingResponse
{
"type": "object",
"title": "AutotaskMappingResponse",
"properties": {
"company": {
"$ref": "#/components/schemas/AutotaskMappingResponseCompany"
},
"service": {
"$ref": "#/components/schemas/AutotaskMappingResponseService"
},
"contract": {
"$ref": "#/components/schemas/AutotaskMappingResponseContract"
},
"organization": {
"$ref": "#/components/schemas/AutotaskMappingResponseOrganization"
},
"lastSyncStatus": {
"type": "string"
},
"lastSyncDateTime": {
"type": "string"
}
},
"description": "Autotask mapping GET response"
}
AutotaskMappingResponseCompany
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
AutotaskMappingResponseContract
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
AutotaskMappingResponseOrganization
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
AutotaskMappingResponseService
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"nonBillableUsers": {
"type": "integer"
}
}
}
AutotaskRetrieveContractsFieldsResponse
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutotaskContractField"
}
},
"totalCount": {
"type": "integer"
}
}
}
AutotaskRetrieveContractsResponse
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutotaskContract"
}
},
"totalCount": {
"type": "integer"
}
}
}
AutotaskRetrieveMappingsResponse
{
"type": "object",
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutotaskMappingResponse"
}
},
"totalCount": {
"type": "number"
}
}
}
AutotaskRetrieveServicesResponse
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutotaskService"
}
},
"totalCount": {
"type": "integer"
}
}
}
AutotaskService
{
"type": "object",
"title": "AutotaskService",
"required": [
"id",
"name",
"contractId"
],
"properties": {
"id": {
"type": "string",
"description": "The contract service identifier."
},
"name": {
"type": "string",
"description": "The autotask service name linked to this contract service."
},
"contractId": {
"type": "string",
"description": "The autotask contract identifier linked to this contract service."
}
},
"description": "Autotask contract service details"
}
AutotaskSettings
{
"type": "object",
"title": "Get Autotask integration settings GET object",
"properties": {
"companyTypeIds": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The array of Autotask companyType IDs applicable to the Provider."
},
"automaticTicketing": {
"type": "boolean",
"description": "Determine whether Autotask uses automatic ticketing"
}
},
"description": "Autotask integration settings"
}
AutotaskSettingsPatchReq
{
"type": "object",
"title": "Update Autotask Integration's Settings PATCH object",
"properties": {
"companyTypeIds": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 150,
"description": "The array of Autotask companyType IDs applicable to the Provider."
},
"automaticTicketing": {
"type": "boolean",
"description": "Determine whether Autotask uses automatic ticketing"
}
},
"x-examples": {
"example-1": {
"companyTypeIds": [
0,
1
],
"automaticTicketing": true
}
},
"description": "Request for updating a Autotask integration's settings"
}
AutotaskTicketingAlertConfiguration
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"queue": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"source": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"dueDays": {
"type": "integer"
},
"category": {
"type": "string"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"resource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
}
}
},
"description": {
"type": "string"
},
"destination": {
"enum": [
"queue",
"resource"
],
"type": "string"
},
"displayName": {
"type": "string"
},
"shouldCreateTickets": {
"type": "boolean"
}
},
"description": "An AutotaskTicketingAlertConfiguration object requires a queueId if the destination is queue. If the destination is resource, resource.id and resource.role.id are required."
}
AutotaskTicketingAlertConfigurationList
{
"type": "object",
"required": [
"records"
],
"properties": {
"records": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"alertId": {
"type": "string"
}
}
},
{
"$ref": "#/components/schemas/AutotaskTicketingAlertConfiguration"
}
]
}
}
}
}
AutotaskTicketingAlertConfigurationOption
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"value": {
"type": "integer"
}
}
}
}
}
}
AutotaskTicketingAlertConfigurationOptions
{
"type": "object",
"properties": {
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutotaskTicketingAlertConfigurationOption"
}
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutotaskTicketingAlertConfigurationResource"
}
}
}
}
AutotaskTicketingAlertConfigurationRequest
{
"type": "object",
"required": [
"shouldCreateTickets",
"priority",
"status",
"dueDays",
"destination"
],
"properties": {
"queue": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"source": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"dueDays": {
"type": "integer"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"resource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
}
}
},
"destination": {
"enum": [
"queue",
"resource"
],
"type": "string"
},
"shouldCreateTickets": {
"type": "boolean"
}
},
"description": "An AutotaskTicketingAlertConfigurationRequest object requires a queueId if the destination is queue. If the destination is resource, resource.id and resource.role.id are required."
}
AutotaskTicketingAlertConfigurationResource
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"value": {
"type": "integer"
}
}
}
}
}
}
AutotaskUpdateConfigurationResponse
{
"type": "object",
"properties": {}
}
BillingGetContractResponse
{
"type": "string",
"format": "binary"
}
BillingIntegrationCompanyType
{
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "number",
"description": "The company type identifier."
},
"name": {
"type": "string",
"description": "The company type name."
}
},
"description": "Billing Integration company type"
}
BulkUserExpiresRequest
{
"type": "array",
"items": {
"$ref": "#/components/schemas/bulk-user-expire"
}
}
BulkUserStatesCreate400Response
{
"type": "object",
"properties": {}
}
BulkUserStatesCreate401Response
{
"type": "object",
"properties": {}
}
BulkUserStatesCreate500Response
{
"type": "object",
"properties": {}
}
BulkUserStatesCreateResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/scheduled-userstate-result"
}
}
BulkUserStatesGetNextScheduledResponse
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/scheduled-userstate-result"
}
},
"events_count": {
"type": "integer",
"description": "The total number of ACTIVATED and SUSPENDED events to a max depth of 1 for\nall of the users in the query. A value larger than the limit specified on\nthe query indicates that additional calls are needed, using a skip greater\nthan 0, to retrieve the full set of results."
}
}
}
BulkUserStatesListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/scheduled-userstate-result"
}
}
BulkUserUnlocksRequest
{
"type": "array",
"items": {
"$ref": "#/components/schemas/bulk-user-unlock"
}
}
BulkUsersCreateRequest
{
"type": "array",
"items": {
"$ref": "#/components/schemas/bulk-user-create"
}
}
BulkUsersCreateResultsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/job-workresult"
}
}
BulkUsersUpdateRequest
{
"type": "array",
"items": {
"$ref": "#/components/schemas/bulk-user-update"
}
}
Case
{
"type": "object",
"title": "Case",
"properties": {
"os": {
"type": "string"
},
"date": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"subject": {
"type": "string"
},
"reporter": {
"type": "string"
},
"caseNumber": {
"type": "string"
},
"description": {
"type": "string"
},
"organization": {
"type": "string"
},
"reporterEmail": {
"type": "string"
},
"caseSubmissionProductType": {
"type": "string"
}
},
"description": "Details of the case (support/feature request)"
}
CasesMetadataResponse
{
"type": "object",
"title": "CasesMetadataResponse",
"properties": {
"results": {
"type": "object",
"properties": {
"os": {
"type": "array",
"items": {
"type": "string"
}
},
"products": {
"type": "array",
"items": {
"type": "string"
}
},
"statuses": {
"type": "array",
"items": {
"type": "string"
}
},
"caseTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"severities": {
"type": "array",
"items": {
"type": "string"
}
},
"productServiceGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"preferredResponseTimes": {
"type": "array",
"items": {
"type": "string"
}
},
"caseSubmissionProductTypes": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"description": "Response for retrieving the cases's metdata"
}
CasesResponse
{
"type": "object",
"title": "CasesResponse",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Case"
}
},
"totalCount": {
"type": "integer"
}
},
"description": "Response for retrieving the cases (support/feature requests)"
}
ConfiguredPolicyTemplate
{
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfiguredPolicyTemplateValue"
}
},
"policyTemplateId": {
"type": "string"
}
}
}
ConfiguredPolicyTemplateValue
{
"example": {
"id": "63e6722746d3949ea9c073cc",
"name": "setallowDeviceNameModification",
"value": true
},
"properties": {
"name": {
"type": "string"
},
"value": {
"description": "The value of this Configured Policy Template Value"
},
"configFieldId": {
"type": "string",
"description": "The ObjectId of the corresponding Policy Template configuration field."
}
}
}
ConnectWiseMappingRequest
{
"type": "object",
"minItems": 1,
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"organization",
"company"
],
"properties": {
"delete": {
"type": "boolean"
},
"company": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"addition": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
}
},
"agreement": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
}
},
"organization": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string"
}
}
}
}
}
}
},
"x-examples": {
"Delete Mapping": {
"data": [
{
"delete": true,
"organization": {
"id": "orgId-1",
"name": "string"
}
},
{
"delete": true,
"organization": {
"id": "orgId-2",
"name": "string"
}
},
{
"delete": true,
"organization": {
"id": "orgId-3",
"name": "string"
}
}
]
},
"Create\\Edit Existing Mapping example": [
{
"company": {
"id": "string",
"name": "string"
},
"addition": {
"id": "string",
"name": "string"
},
"agreement": {
"id": "string",
"name": "string"
},
"organization": {
"id": "newOrganizationId",
"name": "string"
}
},
{
"company": {
"id": "string",
"name": "string"
},
"addition": {
"id": "string",
"name": "string"
},
"agreement": {
"id": "string",
"name": "string"
},
"organization": {
"id": "existingOrganizationId",
"name": "string"
}
}
]
},
"description": "Request object for creating ConnectWise mappings"
}
ConnectWiseMappingResponse
{
"type": "object",
"title": "ConnectWiseMappingResponse",
"properties": {
"company": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"addition": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"agreement": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"organization": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"lastSyncStatus": {
"type": "string"
},
"lastSyncDateTime": {
"type": "string"
}
},
"description": "ConnectWise mapping GET response"
}
ConnectWiseSettings
{
"type": "object",
"title": "Get ConnectWise integration settings GET object",
"properties": {
"companyTypeIds": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The array of ConnectWise companyType IDs applicable to the Provider."
},
"automaticTicketing": {
"type": "boolean",
"description": "Determine whether ConnectWise uses automatic ticketing"
}
},
"description": "ConnectWise integration settings"
}
ConnectWiseSettingsPatchReq
{
"type": "object",
"title": "Update ConnectWise Integration's Settings PATCH object",
"properties": {
"companyTypeIds": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 150,
"description": "The array of ConnectWise companyType IDs applicable to the Provider."
},
"automaticTicketing": {
"type": "boolean",
"description": "Determine whether ConnectWise uses automatic ticketing"
}
},
"x-examples": {
"example-1": {
"companyTypeIds": [
0,
1
],
"automaticTicketing": true
}
},
"description": "Request for updating a ConnectWise integration's settings"
}
ConnectWiseTicketingAlertConfiguration
{
"type": "object",
"required": [
"shouldCreateTickets"
],
"properties": {
"id": {
"type": "integer"
},
"source": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"dueDays": {
"type": "integer"
},
"category": {
"type": "string"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"description": {
"type": "string"
},
"displayName": {
"type": "string"
},
"shouldCreateTickets": {
"type": "boolean"
}
}
}
ConnectWiseTicketingAlertConfigurationList
{
"type": "object",
"required": [
"records"
],
"properties": {
"records": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"alertId": {
"type": "string"
}
}
},
{
"$ref": "#/components/schemas/ConnectWiseTicketingAlertConfiguration"
}
]
}
}
}
}
ConnectWiseTicketingAlertConfigurationOption
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"value": {
"type": "integer"
}
}
}
}
}
}
ConnectWiseTicketingAlertConfigurationOptions
{
"type": "object",
"required": [
"records"
],
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConnectWiseTicketingAlertConfigurationOption"
}
}
}
}
ConnectWiseTicketingAlertConfigurationRequest
{
"type": "object",
"required": [
"shouldCreateTickets"
],
"properties": {
"source": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"dueDays": {
"type": "integer"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"shouldCreateTickets": {
"type": "boolean"
}
}
}
ConnectwiseAddition
{
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"description": "The addition identifier."
},
"name": {
"type": "string",
"description": "The addition name."
}
},
"description": "Connectwise addition details"
}
ConnectwiseAgreement
{
"type": "object",
"required": [
"id",
"name",
"companyId"
],
"properties": {
"id": {
"type": "string",
"description": "The agreement identifier."
},
"name": {
"type": "string",
"description": "The agreement name."
},
"companyId": {
"type": "string",
"description": "The ConnectWise company identifier linked to agreement."
}
},
"description": "Connectwise agreement details"
}
ConnectwiseCompany
{
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"description": "The company identifier."
},
"name": {
"type": "string",
"description": "The company name."
}
},
"description": "Connectwise company details"
}
ConnectwiseCompanyResp
{
"type": "object",
"required": [
"totalCount",
"records"
],
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConnectwiseCompany"
}
},
"totalCount": {
"type": "integer"
}
},
"description": "Response for retrieving ConnectWise companies"
}
ConnectwiseCompanyTypeResp
{
"type": "object",
"required": [
"totalCount",
"records"
],
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillingIntegrationCompanyType"
}
},
"totalCount": {
"type": "integer"
}
},
"description": "Response for retrieving ConnectWise company types"
}
ConnectwiseCreateConfiguration422Response
{
"type": "object",
"properties": {}
}
ConnectwiseCreateConfigurationResponse
{
"type": "object",
"required": [
"integrationId"
],
"properties": {
"integrationId": {
"type": "string",
"description": "The identifier of the created integration"
}
}
}
ConnectwiseIntegration
{
"type": "object",
"title": "Get ConnectWise integration GET object",
"required": [
"id",
"url",
"companyId"
],
"properties": {
"id": {
"type": "string",
"description": "The identifier for this ConnectWise integration."
},
"url": {
"type": "string",
"description": "The base url for connecting to ConnectWise."
},
"companyId": {
"type": "string",
"description": "The ConnectWise company identifier."
},
"isMspAuthConfigured": {
"type": "boolean",
"description": "Has the msp-api been configured with auth data yet"
}
},
"description": "ConnectWise integration configuration details"
}
ConnectwiseIntegrationPatchReq
{
"type": "object",
"title": "Create ConnectWise Integration PATCH object",
"properties": {
"url": {
"type": "string",
"description": "The base url for connecting to ConnectWise."
},
"companyId": {
"type": "string",
"description": "The ConnectWise company identifier."
},
"publicKey": {
"type": "string",
"description": "The ConnectWise public key for authentication."
},
"privateKey": {
"type": "string",
"description": "The ConnectWise private key for authentication"
}
},
"description": "Request for updating a ConnectWise integration"
}
ConnectwiseIntegrationReq
{
"type": "object",
"title": "Create ConnectWise Integration POST object",
"required": [
"url",
"companyId",
"publicKey",
"privateKey"
],
"properties": {
"url": {
"type": "string",
"description": "The base url for connecting to ConnectWise."
},
"companyId": {
"type": "string",
"description": "The ConnectWise company identifier."
},
"publicKey": {
"type": "string",
"description": "The ConnectWise public key for authentication."
},
"privateKey": {
"type": "string",
"description": "The ConnectWise private key for authentication"
}
},
"description": "Request for creating a ConnectWise integration"
}
ConnectwiseRetrieveAdditionsResponse
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConnectwiseAddition"
}
},
"totalCount": {
"type": "integer"
}
}
}
ConnectwiseRetrieveAgreementsResponse
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConnectwiseAgreement"
}
},
"totalCount": {
"type": "integer"
}
}
}
ConnectwiseRetrieveMappingsResponse
{
"type": "object",
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConnectWiseMappingResponse"
}
},
"totalCount": {
"type": "number"
}
}
}
ConnectwiseUpdateConfigurationResponse
{
"type": "object",
"properties": {}
}
CreateOrganization
{
"type": "object",
"title": "CreateOrganization",
"example": {
"name": "Acme Inc",
"maxSystemUsers": 10
},
"properties": {
"name": {
"type": "string"
},
"maxSystemUsers": {
"type": "integer",
"description": "The maximum number of users allowed in this organization. Requires organizations.billing scope to modify."
}
}
}
CustomEmail
{
"type": "object",
"title": "CustomEmail",
"required": [
"type",
"subject"
],
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"body": {
"type": "string",
"minLength": 0
},
"type": {
"$ref": "#/components/schemas/CustomEmailType"
},
"title": {
"type": "string",
"minLength": 0
},
"button": {
"type": "string",
"minLength": 0
},
"header": {
"type": "string",
"minLength": 0
},
"subject": {
"type": "string",
"minLength": 0
},
"nextStepContactInfo": {
"type": "string",
"minLength": 0
}
},
"description": "Custom email content created by the admin user to personalize emails sent to their system users."
}
CustomEmailTemplate
{
"type": "object",
"title": "CustomEmailTemplate",
"properties": {
"type": {
"$ref": "#/components/schemas/CustomEmailType"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomEmailTemplateField"
}
},
"description": {
"type": "string"
},
"displayName": {
"type": "string"
}
}
}
CustomEmailTemplateField
{
"type": "object",
"title": "CustomEmailTemplateField",
"properties": {
"field": {
"type": "string"
},
"multiline": {
"type": "boolean"
},
"displayName": {
"type": "string"
},
"defaultValue": {
"type": "string"
}
}
}
CustomEmailType
{
"enum": [
"activate_gapps_user",
"activate_o365_user",
"lockout_notice_user",
"password_expiration",
"password_expiration_warning",
"password_reset_confirmation",
"user_change_password",
"activate_user_custom"
],
"type": "string"
}
CustomEmailsGetTemplatesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomEmailTemplate"
}
}
DEP
{
"type": "object",
"title": "DEP",
"properties": {
"welcomeScreen": {
"$ref": "#/components/schemas/DEPWelcomeScreen"
},
"setupAssistantOptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DEPSetupAssistantOption"
}
},
"enableZeroTouchEnrollment": {
"type": "boolean",
"description": "A toggle to determine if DEP registered devices should go through JumpCloud Zero Touch Enrollment."
}
},
"x-deprecated": true
}
DEPSetupAssistantOption
{
"type": "object",
"title": "DEP Setup Assistant Option",
"properties": {
"option": {
"$ref": "#/components/schemas/SetupAssistantOption"
}
}
}
DEPWelcomeScreen
{
"type": "object",
"title": "DEPWelcomeScreen",
"properties": {
"title": {
"type": "string",
"maxLength": 255,
"description": "The title to display on the DEP Welcome Screen."
},
"button": {
"type": "string",
"maxLength": 64,
"description": "Text to display on the button on the DEP Welcome Screen."
},
"paragraph": {
"type": "string",
"maxLength": 1024,
"description": "A message to display on the DEP Welcome Screen."
}
},
"x-examples": {
"defaults": {
"title": "Welcome",
"button": "continue",
"paragraph": "In just a few steps, you will be working securely from your Mac."
}
}
}
DevicesEraseDeviceRequest
{
"type": "object"
}
DevicesEraseDeviceResponse
{
"type": "object",
"example": {},
"properties": {}
}
DevicesLockDeviceResponse
{
"type": "object",
"example": {},
"properties": {}
}
DevicesRebootDeviceResponse
{
"type": "object",
"example": {},
"properties": {}
}
DevicesResetPasswordRequest
{
"type": "object",
"properties": {
"flags": {
"type": "array",
"items": {
"type": "string"
}
},
"newPassword": {
"type": "string",
"description": "Not logging as it contains sensitive information."
}
}
}
DevicesResetPasswordResponse
{
"type": "object",
"example": {},
"properties": {}
}
DirectoriesListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Directory"
}
}
Directory
{
"type": "object",
"title": "Directory",
"required": [
"id",
"name",
"type"
],
"properties": {
"id": {
"type": "string",
"description": "The ObjectID of the directory."
},
"name": {
"type": "string",
"description": "The name of the directory."
},
"type": {
"enum": [
"active_directory",
"g_suite",
"ldap_server",
"office_365",
"workday"
],
"type": "string",
"description": "The type of directory."
},
"oAuthStatus": {
"type": "object",
"description": "the expiry and error status of the bearer token"
},
"defaultDomain": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"domain": {
"type": "string"
}
},
"description": "The default domain object if exists, contains id and name of the domain."
}
},
"description": ""
}
DomainsInsertRequest
{
"type": "object",
"properties": {
"domain": {
"type": "string"
}
}
}
DuoAccount
{
"type": "object",
"title": "DuoAccount",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "object ID"
},
"name": {
"type": "string",
"description": "Duo application name."
}
}
}
DuoAccountListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/DuoAccount"
}
}
DuoApplication
{
"type": "object",
"title": "DuoApplication",
"required": [
"id",
"name",
"apiHost",
"integrationKey"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"apiHost": {
"type": "string"
},
"integrationKey": {
"type": "string"
}
}
}
DuoApplicationListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/DuoApplication"
}
}
DuoApplicationReq
{
"type": "object",
"title": "DuoApplicationReq",
"required": [
"name",
"apiHost",
"integrationKey",
"secretKey"
],
"properties": {
"name": {
"type": "string"
},
"apiHost": {
"type": "string"
},
"secretKey": {
"type": "string"
},
"integrationKey": {
"type": "string"
}
}
}
DuoApplicationUpdateReq
{
"type": "object",
"title": "DuoApplicationUpdateReq",
"required": [
"name",
"apiHost",
"integrationKey"
],
"properties": {
"name": {
"type": "string"
},
"apiHost": {
"type": "string"
},
"secretKey": {
"type": "string"
},
"integrationKey": {
"type": "string"
}
}
}
EnrollmentTokensCreateEnterprisesEnrollmentTokenRequest
{
"type": "object",
"properties": {
"duration": {
"type": "string",
"title": "duration format as mentioned in https://developers.google.com/android/management/reference/rest/v1/enterprises.enrollmentTokens"
},
"zeroTouch": {
"type": "boolean"
},
"displayName": {
"type": "string",
"title": "Name as set by admin"
},
"oneTimeOnly": {
"type": "boolean",
"title": "If the flag is set to true, only one device can use generated token for\nenrollment"
},
"createdWhere": {
"$ref": "#/components/schemas/jumpcloud.google_emm.CreatedWhere"
},
"userObjectId": {
"type": "string",
"format": "byte"
},
"enrollmentType": {
"$ref": "#/components/schemas/jumpcloud.google_emm.EnrollmentType"
},
"allowPersonalUsage": {
"$ref": "#/components/schemas/jumpcloud.google_emm.AllowPersonalUsage"
},
"provisioningExtras": {
"$ref": "#/components/schemas/jumpcloud.google_emm.ProvisioningExtras"
}
}
}
EnrollmentsDownloadConfigFilesResponse
{
"type": "string",
"format": "binary"
}
EnterprisesDeleteEnterpriseResponse
{
"type": "object",
"properties": {}
}
EnterprisesPatchEnterpriseRequest
{
"type": "object",
"properties": {
"deviceGroupId": {
"type": "string",
"format": "byte"
},
"allowDeviceEnrollment": {
"type": "boolean"
}
}
}
Error
{
"type": "object",
"title": "Error",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"description": "HTTP status code"
},
"status": {
"type": "string",
"description": "HTTP status description"
},
"message": {
"type": "string",
"description": "Error message"
}
},
"x-examples": {},
"description": ""
}
ErrorDetails
{
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"type": "object",
"properties": {
"details": {
"type": "array",
"items": {
"type": "object",
"description": "Object according to Google's API.",
"additionalProperties": true
},
"description": "Describes a list of objects with more detailed information of the given error. Each detail schema is according to one of the messages defined in Google's API: https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto"
}
}
}
]
}
FeatureTrialData
{
"type": "object",
"title": "FeatureTrials",
"properties": {
"endDate": {
"type": "string"
},
"startDate": {
"type": "string"
}
},
"description": "Feature usage data for a feature"
}
GSuiteBuiltinTranslation
{
"enum": [
"user_home_addresses",
"user_work_addresses",
"user_other_addresses",
"user_home_phone_numbers",
"user_mobile_phone_numbers",
"user_other_phone_numbers",
"user_work_phone_numbers",
"user_work_fax_phone_numbers",
"user_work_mobile_phone_numbers",
"user_manager",
"user_alternate_email",
"user_primary_organization_cost_center",
"user_primary_organization_department",
"user_primary_organization_description",
"user_primary_organization_employee_id",
"user_primary_organization_title",
"user_status",
"user_password"
],
"type": "string",
"title": "G Suite BuiltIn Translation",
"description": "Built-in translations for G Suite export:\n* `user_home_addresses` - Translate all JumpCloud user addresses of type `home` to G Suite Directory user addresses of type `home`\n* `user_work_addresses` - Translate all JumpCloud user addresses of type `work` to G Suite Directory user addresses of type `work`\n* `user_other_addresses` - Translate all JumpCloud user addresses of type `other` to G Suite Directory user addresses of type `other`\n* `user_home_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `home` to G Suite Directory user phones of type `home`\n* `user_mobile_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `mobile` to G Suite Directory user phones of type `mobile`\n* `user_other_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `other` to G Suite Directory user phones of type `other`\n* `user_work_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work` to G Suite Directory user phones of type `work`\n* `user_work_fax_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work_fax` to G Suite Directory user phones of type `work_fax`\n* `user_work_mobile_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work_mobile` to G Suite Directory user phones of type `work_mobile`\n* `user_manager` - Translate JumpCloud user `manager` to G Suite Directory user `relations-manager`\n* `user_primary_organization_cost_center` - Translate JumpCloud user `costCenter` to G Suite Directory user `costCenter` for `primary` organization\n* `user_primary_organization_department` - Translate JumpCloud user `department` to G Suite Directory user `department` for `primary` organization\n* `user_primary_organization_description` - Translate JumpCloud user `employeeType` to G Suite Directory user `description` for `primary` organization\n* `user_primary_organization_employee_id` - Translate JumpCloud user `employeeIdentifier` to G Suite Directory user `externalIds` element of type `organization`\n* `user_primary_organization_title` - Translate JumpCloud user `jobTitle` to G Suite Directory user `title` for `primary` organization\n* `user_alternate_email` - Translate JumpCloud user `alternateEmail` to G Suite Directory user `emails`\n* `user_status` - Translate JumpCloud user `status` to G Suite Directory user `status`\n* `user_password` - Translate JumpCloud user `password` to G Suite Directory user `password`\n"
}
GSuiteDeleteScheduledJob204Response
{
"type": "object",
"example": {},
"properties": {}
}
GSuiteDeleteScheduledJobResponse
{
"type": "object",
"properties": {}
}
GSuiteDirectionTranslation
{
"enum": [
"export",
"import"
],
"type": "string",
"title": "G Suite Direction translation",
"default": "export",
"description": "Direction identify if an attribute is going to be exported or imported from GSuite\n* `Import`- The data will be imported from GSuite into the user modal\n* `Export`- The data will be exported from the user modal to GSuite\n"
}
GSuiteTranslationRule
{
"type": "object",
"title": "G Suite Translation Rule",
"properties": {
"id": {
"type": "string",
"description": "ObjectId uniquely identifying a Translation Rule."
},
"builtIn": {
"$ref": "#/components/schemas/GSuiteBuiltinTranslation"
},
"direction": {
"$ref": "#/components/schemas/GSuiteDirectionTranslation"
}
}
}
GSuiteTranslationRuleRequest
{
"type": "object",
"title": "G Suite Translation Rule Request",
"example": {
"builtIn": "user_home_addresses",
"direction": "export"
},
"properties": {
"builtIn": {
"$ref": "#/components/schemas/GSuiteBuiltinTranslation"
},
"direction": {
"$ref": "#/components/schemas/GSuiteDirectionTranslation"
}
}
}
GraphActiveDirectoryAssociationsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphConnection"
}
}
GraphActiveDirectoryTraverseUserGroupResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphActiveDirectoryTraverseUserResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphApplicationAssociationsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphConnection"
}
}
GraphApplicationTraverseUserGroupResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphApplicationTraverseUserResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphAttribute-LdapGroups
{
"type": "object",
"title": "GraphAttribute (LdapGroups)",
"properties": {
"ldapGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LdapGroup"
}
}
},
"description": "List of LDAP groups to provision when this JumpCloud group is bound to an LDAP instance."
}
GraphAttribute-PosixGroups
{
"type": "object",
"title": "GraphAttribute (PosixGroups)",
"properties": {
"posixGroups": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
}
}
},
"description": "List of POSIX groups to provision when this JumpCloud group is bound to a supported resource."
}
GraphAttribute-Radius
{
"type": "object",
"title": "GraphAttribute (Radius)",
"properties": {
"radius": {
"type": "object",
"nullable": true,
"properties": {
"reply": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
}
},
"description": "RADIUS reply attributes are returned in the Access-Accept messages sent to endpoints that authenticate with JumpCloud RADIUS."
}
GraphAttribute-SambaEnabled
{
"type": "object",
"title": "GraphAttribute (SambaEnabled)",
"properties": {
"sambaEnabled": {
"type": "boolean"
}
},
"description": "Enabling Samba support allows for LDAP users to authenticate to endpoints that require Samba attributes within the LDAP directory"
}
GraphAttribute-Sudo
{
"type": "object",
"title": "GraphAttribute (Sudo)",
"properties": {
"sudo": {
"type": "object",
"nullable": true,
"required": [
"enabled",
"withoutPassword"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Enables sudo"
},
"withoutPassword": {
"type": "boolean",
"description": "Enable sudo without password (requires 'enabled' to be true)"
}
}
}
},
"description": "Setting user access controls in order to grant administrator permissions"
}
GraphAttributes
{
"type": "object",
"title": "GraphAttributes",
"description": "The graph attributes.",
"additionalProperties": true
}
GraphCommandAssociationsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphConnection"
}
}
GraphCommandTraverseSystemGroupResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphCommandTraverseSystemResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphConnection
{
"type": "object",
"title": "GraphConnection",
"required": [
"to"
],
"properties": {
"to": {
"$ref": "#/components/schemas/GraphObject"
},
"from": {
"$ref": "#/components/schemas/GraphObject"
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
}
},
"description": "Represents an edge between two graph objects. From can be omitted if it is clear from context."
}
GraphGSuiteAssociationsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphConnection"
}
}
GraphGSuiteTraverseUserGroupResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphGSuiteTraverseUserResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphIdpRoutingPolicyAssociationsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphConnection"
}
}
GraphIdpRoutingPolicyTraverseUserGroupResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphIdpRoutingPolicyTraverseUserResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphLdapServerAssociationsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphConnection"
}
}
GraphLdapServerTraverseUserGroupResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphLdapServerTraverseUserResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphObject
{
"type": "object",
"title": "GraphObject",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The ObjectID of the graph object."
},
"type": {
"type": "string",
"description": "The type of graph object."
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
}
}
}
GraphObjectWithPaths
{
"type": "object",
"title": "GraphObjectWithPaths",
"required": [
"type",
"id",
"paths"
],
"properties": {
"id": {
"type": "string",
"description": "Object ID of this graph object."
},
"type": {
"$ref": "#/components/schemas/GraphType"
},
"paths": {
"type": "array",
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphConnection"
}
},
"description": "A path through the graph between two graph objects."
},
"compiledAttributes": {
"$ref": "#/components/schemas/GraphAttributes"
}
}
}
GraphOffice365AssociationsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphConnection"
}
}
GraphOffice365TraverseUserGroupResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphOffice365TraverseUserResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphOperation
{
"type": "object",
"title": "GraphOperation",
"required": [
"id",
"op"
],
"properties": {
"id": {
"type": "string",
"description": "The ObjectID of graph object being added or removed as an association."
},
"op": {
"enum": [
"add",
"remove",
"update"
],
"type": "string",
"description": "How to modify the graph connection."
}
}
}
GraphOperation-ActiveDirectory
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/GraphOperation"
},
{
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"user",
"user_group"
],
"type": "string",
"description": "Targets which a \"active_directory\" can be associated to."
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
}
}
}
],
"title": "GraphOperation (ActiveDirectory)"
}
GraphOperation-Application
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/GraphOperation"
},
{
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"user",
"user_group"
],
"type": "string",
"description": "Targets which a \"application\" can be associated to."
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
}
}
}
],
"title": "GraphOperation (Application)"
}
GraphOperation-Command
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/GraphOperation"
},
{
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"system",
"system_group"
],
"type": "string",
"description": "Targets which a \"command\" can be associated to."
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
}
}
}
],
"title": "GraphOperation (Command)"
}
GraphOperation-GSuite
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/GraphOperation"
},
{
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"user",
"user_group"
],
"type": "string",
"description": "Targets which a \"g_suite\" can be associated to."
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
}
}
}
],
"title": "GraphOperation (GSuite)"
}
GraphOperation-IDPRoutingPolicy
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/GraphOperation"
},
{
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"user",
"user_group"
],
"type": "string",
"description": "Targets which an \"idp_routing_policy\" can be associated to."
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
}
}
}
],
"title": "GraphOperation (IDPRoutingPolicy)"
}
GraphOperation-LdapServer
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/GraphOperation"
},
{
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"user",
"user_group"
],
"type": "string",
"description": "Targets which a \"ldap_server\" can be associated to."
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
}
}
}
],
"title": "GraphOperation (LdapServer)"
}
GraphOperation-Office365
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/GraphOperation"
},
{
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"user",
"user_group"
],
"type": "string",
"description": "Targets which a \"office_365\" can be associated to."
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
}
}
}
],
"title": "GraphOperation (Office365)"
}
GraphOperation-Policy
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/GraphOperation"
},
{
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"system",
"system_group"
],
"type": "string",
"description": "Targets which a \"policy\" can be associated to."
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
}
}
}
],
"title": "GraphOperation (Policy)"
}
GraphOperation-PolicyGroup
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/GraphOperation"
},
{
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"system",
"system_group"
],
"type": "string",
"description": "Targets which a \"policy_group\" can be associated to."
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
}
}
}
],
"title": "GraphOperation (PolicyGroup)"
}
GraphOperation-PolicyGroup-Member
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/GraphOperation"
},
{
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"policy"
],
"type": "string",
"description": "The member type."
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
}
}
}
],
"title": "GraphOperation (PolicyGroup-Member)"
}
GraphOperation-RadiusServer
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/GraphOperation"
},
{
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"user",
"user_group"
],
"type": "string",
"description": "Targets which a \"radius_server\" can be associated to."
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
}
}
}
],
"title": "GraphOperation (RadiusServer)"
}
GraphOperation-SoftwareApp
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/GraphOperation"
},
{
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"system",
"system_group"
],
"type": "string",
"description": "Targets which a \"software_app\" can be associated to."
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
}
}
}
],
"title": "GraphOperation (SoftwareApp)"
}
GraphOperation-System
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/GraphOperation"
},
{
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"command",
"policy",
"policy_group",
"user",
"user_group"
],
"type": "string",
"description": "Targets which a \"system\" can be associated to."
},
"attributes": {
"allOf": [
{
"$ref": "#/components/schemas/GraphAttributes"
},
{
"$ref": "#/components/schemas/GraphAttribute-Sudo"
}
]
}
}
}
],
"title": "GraphOperation (System)"
}
GraphOperation-SystemGroup
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/GraphOperation"
},
{
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"command",
"policy",
"policy_group",
"user",
"user_group"
],
"type": "string",
"description": "Targets which a \"system_group\" can be associated to."
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
}
}
}
],
"title": "GraphOperation (SystemGroup)"
}
GraphOperation-SystemGroup-Member
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/GraphOperation"
},
{
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"system"
],
"type": "string",
"description": "The member type."
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
}
}
}
],
"title": "GraphOperation (SystemGroup-Member)"
}
GraphOperation-User
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/GraphOperation"
},
{
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"active_directory",
"application",
"g_suite",
"idp_routing_policy",
"ldap_server",
"office_365",
"radius_server",
"system",
"system_group"
],
"type": "string",
"description": "Targets which a \"user\" can be associated to."
},
"attributes": {
"allOf": [
{
"$ref": "#/components/schemas/GraphAttributes"
},
{
"$ref": "#/components/schemas/GraphAttribute-Sudo"
}
]
}
}
}
],
"title": "GraphOperation (User)"
}
GraphOperation-UserGroup
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/GraphOperation"
},
{
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"active_directory",
"application",
"g_suite",
"idp_routing_policy",
"ldap_server",
"office_365",
"radius_server",
"system",
"system_group"
],
"type": "string",
"description": "Targets which a \"user_group\" can be associated to."
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
}
}
}
],
"title": "GraphOperation (UserGroup)"
}
GraphOperation-UserGroup-Member
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/GraphOperation"
},
{
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"user"
],
"type": "string",
"description": "The member type."
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
}
}
}
],
"title": "GraphOperation (UserGroup-Member)"
}
GraphPolicyAssociationsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphConnection"
}
}
GraphPolicyGroupAssociationsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphConnection"
}
}
GraphPolicyGroupMembersListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphConnection"
}
}
GraphPolicyGroupMembershipResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphPolicyGroupTraverseSystemGroupResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphPolicyGroupTraverseSystemResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphPolicyMemberOfResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphPolicyTraverseSystemGroupResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphPolicyTraverseSystemResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphRadiusServerAssociationsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphConnection"
}
}
GraphRadiusServerTraverseUserGroupResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphRadiusServerTraverseUserResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphSoftwareappsAssociationsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphConnection"
}
}
GraphSoftwareappsTraverseSystemGroupResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphSoftwareappsTraverseSystemResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphSystemAssociationsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphConnection"
}
}
GraphSystemGroupAssociationsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphConnection"
}
}
GraphSystemGroupMembersListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphConnection"
}
}
GraphSystemGroupMembershipResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphSystemGroupTraverseCommandResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/commandsGraphObjectWithPaths"
}
}
GraphSystemGroupTraversePolicyGroupResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphSystemGroupTraversePolicyResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphSystemGroupTraverseUserGroupResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphSystemGroupTraverseUserResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphSystemMemberOfResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphSystemTraverseCommandResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/commandsGraphObjectWithPaths"
}
}
GraphSystemTraversePolicyGroupResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphSystemTraversePolicyResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphSystemTraverseUserGroupResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphSystemTraverseUserResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphType
{
"enum": [
"active_directory",
"application",
"command",
"g_suite",
"idp_routing_policy",
"ldap_server",
"office_365",
"policy",
"policy_group",
"radius_server",
"system",
"system_group",
"user",
"user_group"
],
"type": "string",
"title": "GraphType",
"description": "A graph object type."
}
GraphUserAssociationsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphConnection"
}
}
GraphUserGroupAssociationsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphConnection"
}
}
GraphUserGroupMembersListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphConnection"
}
}
GraphUserGroupMembershipResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphUserGroupTraverseActiveDirectoryResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphUserGroupTraverseApplicationResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
GraphUserGroupTraverseDirectoryResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObjectWithPaths"
}
}
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"
}
Office365BuiltinTranslation
{
"enum": [
"user_alternate_email",
"user_business_phones",
"user_city",
"user_country",
"user_department",
"user_job_title",
"user_manager",
"user_mobile_phone",
"user_office_location",
"user_postal_code",
"user_principal_name_from_alternate_email",
"user_state",
"user_street_address"
],
"type": "string",
"title": "Office 365 BuiltIn Translation",
"description": "Built-in translations for Office 365 (Microsoft Graph) export:\n* `user_alternate_email` - Translate `alternateEmail` field of JumpCloud user to `otherMails` field of Microsoft Graph `user`\n* `user_business_phones` - Translate `number` field of first JumpCloud user `phoneNumber` of type `work` to `businessPhones` field of Microsoft Graph `user`\n* `user_city` - Translate `locality` field of JumpCloud user address of type `work` to `city` field of Microsoft Graph user\n* `user_country` - Translate `country` field of JumpCloud user address of type `work` to `country` field of Microsoft Graph `user`\n* `user_department` - Translate `department` field of JumpCloud user to `department` field of Microsoft Graph `user`\n* `user_job_title` - Translate `jobTitle` field of JumpCloud user to `jobTitle` field of Microsoft Graph `user`\n* `user_manager` - Translate `manager` field of JumpCloud user to `manager` field of Microsoft Graph `user`\n* `user_mobile_phone` - Translate `number` field of first JumpCloud user `phoneNumber` of type `mobile` to `mobilePhone` field of Microsoft Graph `user`\n* `user_office_location` - Translate `location` field of JumpCloud user to `officeLocation` field of Microsoft Graph `user`\n* `user_postal_code` - Translate `postalCode` field of JumpCloud user address of type `work` to `postalCode` field of Microsoft Graph `user`\n* `user_principal_name_from_alternate_email` - Translate user `alternateEmail` field of Jumpcloud user to `userPrincipalName` field of Microsoft Graph `user`\n* `user_state` - Translate `region` field of JumpCloud user address of type `work` to `state` field of Microsoft Graph `user`\n* `user_street_address` - Translate `streetAddress` field of JumpCloud user address of type `work` to `streetAddress` field of Microsoft Graph user"
}
Office365DirectionTranslation
{
"enum": [
"export"
],
"type": "string",
"title": "Office 365 Direction translation",
"default": "export",
"description": "Direction identify if a attribute is going to be exported or imported from Office365\n* `Export`- The data will exported from the user modal to Office365\n"
}
Office365SListImportUsersResponse
{
"type": "object",
"properties": {
"top": {
"type": "integer"
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"surname": {
"type": "string"
},
"givenName": {
"type": "string"
},
"userPrincipalName": {
"type": "string"
}
}
}
},
"skipToken": {
"type": "string"
}
}
}
Office365TranslationRule
{
"type": "object",
"title": "Office 365 Translation Rule",
"properties": {
"id": {
"type": "string",
"description": "ObjectId uniquely identifying a Translation Rule."
},
"builtIn": {
"$ref": "#/components/schemas/Office365BuiltinTranslation"
},
"direction": {
"$ref": "#/components/schemas/Office365DirectionTranslation"
}
}
}
Office365TranslationRuleRequest
{
"type": "object",
"title": "Office 365 Translation Rule Request",
"example": {
"builtIn": "user_department",
"direction": "export"
},
"properties": {
"builtIn": {
"$ref": "#/components/schemas/Office365BuiltinTranslation"
},
"direction": {
"$ref": "#/components/schemas/Office365DirectionTranslation"
}
}
}
Organization
{
"type": "object",
"title": "Organization",
"example": {
"id": "624d9eae6849cf3b3f93dc56",
"name": "Acme Inc"
},
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"maxSystemUsers": {
"type": "integer",
"description": "The maximum number of users allowed in this organization. Requires organizations.billing scope to modify."
}
}
}
PasswordsSecurity
{
"type": "object",
"properties": {
"oldPasswords": {
"type": "integer",
"format": "int32",
"example": 10
},
"weakPasswords": {
"type": "integer",
"format": "int32",
"example": 10
},
"reusedPasswords": {
"type": "integer",
"format": "int32",
"example": 10
},
"compromisedPasswords": {
"type": "integer",
"format": "int32",
"example": 10
}
}
}
PhoneNumber
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"maxLength": 1024
},
"number": {
"type": "string",
"maxLength": 1024
}
}
}
PoliciesListAllPolicyResultsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyResult"
}
}
PoliciesListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Policy"
}
}
Policy
{
"type": "object",
"title": "Policy",
"properties": {
"id": {
"type": "string",
"description": "ObjectId uniquely identifying a Policy."
},
"name": {
"type": "string",
"description": "The description for this specific Policy."
},
"template": {
"$ref": "#/components/schemas/PolicyTemplate"
}
},
"description": "An instance of a policy template."
}
PolicyCreateRequest
{
"type": "object",
"title": "PolicyCreateRequest",
"required": [
"name",
"template"
],
"properties": {
"name": {
"type": "string",
"description": "The description for this specific Policy."
},
"notes": {
"type": "string",
"description": "The notes for this specific Policy."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyValue"
}
},
"template": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "ObjectId uniquely identifying a Policy instance."
}
}
}
},
"description": "A request to create an instance of a policy template."
}
PolicyGroup
{
"type": "object",
"title": "PolicyGroup",
"properties": {
"id": {
"type": "string",
"description": "ObjectId uniquely identifying a Policy Group."
},
"name": {
"type": "string",
"description": "Display name of a Policy Group."
},
"type": {
"enum": [
"policy_group"
],
"type": "string",
"description": "The type of the group; always 'policy' for a Policy Group."
},
"email": {
"type": "string",
"description": "E-mail address associated with a Policy Group"
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
},
"description": {
"type": "string",
"description": "Description of a Policy Group"
}
}
}
PolicyGroupData
{
"type": "object",
"title": "PolicyGroupData",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Display name of a Policy Group."
}
}
}
PolicyGroupTemplate
{
"type": "object",
"title": "PolicyGroupTemplate",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyGroupTemplateMember"
}
},
"description": {
"type": "string"
}
}
}
PolicyGroupTemplateMember
{
"type": "object",
"title": "PolicyGroupTemplateMember",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"policyTemplateId": {
"type": "string"
}
}
}
PolicyGroupTemplateMembers
{
"type": "object",
"title": "PolicyGroupTemplateMembers",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyGroupTemplateMember"
}
},
"totalCount": {
"type": "integer"
}
}
}
PolicyGroupTemplates
{
"type": "object",
"title": "PolicyGroupTemplates",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyGroupTemplate"
}
},
"totalCount": {
"type": "integer"
}
}
}
PolicyGroupTemplatesGetConfiguredPolicyTemplateResponse
{
"type": "object",
"example": {},
"properties": {}
}
PolicyGroupTemplatesListConfiguredPolicyTemplatesResponse
{
"type": "object",
"properties": {
"records": {
"$ref": "#/components/schemas/ConfiguredPolicyTemplate"
},
"totalCount": {
"type": "integer"
}
}
}
PolicyGroupsListAllResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyGroup"
}
}
PolicyResult
{
"type": "object",
"title": "PolicyResult",
"properties": {
"id": {
"type": "string",
"description": "ObjectId uniquely identifying a Policy Result."
},
"state": {
"type": "string",
"description": "Enumeration describing the state of the policy. Success, failed, or pending."
},
"detail": {
"type": "string",
"description": "Details pertaining to the policy result."
},
"stdErr": {
"type": "string",
"description": "The STDERR output from applying the policy."
},
"stdOut": {
"type": "string",
"description": "The STDOUT output from applying the policy."
},
"endedAt": {
"type": "string",
"format": "date-time",
"description": "The end of the policy application."
},
"success": {
"type": "boolean",
"description": "True if the policy was successfully applied; false otherwise."
},
"policyID": {
"type": "string",
"description": "ObjectId uniquely identifying the parent Policy."
},
"systemID": {
"type": "string",
"description": "ObjectId uniquely identifying the parent System."
},
"startedAt": {
"type": "string",
"format": "date-time",
"description": "The start of the policy application."
},
"exitStatus": {
"type": "integer",
"format": "uint32",
"description": "The 32-bit unsigned exit status from the applying the policy."
}
}
}
PolicyTemplate
{
"type": "object",
"title": "PolicyTemplate",
"properties": {
"id": {
"type": "string",
"description": "ObjectId uniquely identifying a Policy Template."
},
"name": {
"type": "string",
"description": "The unique name for the Policy Template."
},
"alert": {
"type": "string",
"description": "Text to describe any risk associated with this policy."
},
"state": {
"type": "string",
"default": "",
"description": "String describing the release status of the policy template."
},
"behavior": {
"type": "string",
"description": "Specifics about the behavior of the policy."
},
"reference": {
"type": "string",
"description": "URL to visit for further information."
},
"activation": {
"type": "string",
"description": "Requirements before the policy can be activated."
},
"description": {
"type": "string",
"description": "The default description for the Policy."
},
"displayName": {
"type": "string",
"description": "The default display name for the Policy."
},
"osMetaFamily": {
"enum": [
"linux",
"darwin",
"windows",
"ios",
"universal",
"android"
],
"type": "string"
},
"deliveryTypes": {
"type": "array",
"items": {
"enum": [
"agent",
"mdm"
],
"type": "string",
"default": "agent"
},
"description": "The supported delivery mechanisms for this policy template."
},
"osRestrictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OSRestriction"
}
}
},
"x-examples": {
"example-1": {
"id": "string",
"name": "string",
"alert": "string",
"state": "",
"behavior": "string",
"reference": "string",
"activation": "string",
"description": "string",
"displayName": "string",
"osMetaFamily": "linux",
"deliveryTypes": [
"agent"
],
"osRestrictions": [
{
"osName": "string",
"earliestVersion": "string",
"deprecatedVersion": "string",
"supportedEnrollmentTypes": [
"automated"
]
}
]
}
},
"description": "The shallow information about a Policy Template."
}
PolicyTemplateConfigField
{
"type": "object",
"title": "PolicyTemplateConfigField",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"description": "ObjectId uniquely identifying a Policy Template Configuration Field"
},
"name": {
"type": "string",
"description": "A unique name identifying this config field."
},
"label": {
"type": "string",
"description": "The default label for this field."
},
"tooltip": {
"type": "object",
"properties": {
"template": {
"type": "string"
},
"variables": {
"type": "object",
"properties": {
"icon": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
},
"position": {
"type": "number",
"description": "The default position to render this field."
},
"readOnly": {
"type": "boolean",
"description": "If an admin is allowed to modify this field."
},
"required": {
"type": "boolean",
"description": "If this field is required for this field."
},
"sensitive": {
"type": "boolean",
"description": "Defines if the policy template config field is sensitive or not."
},
"validators": {
"type": "object",
"description": "Descriptors to perform extended assertions on the supplied config field value."
},
"displayType": {
"enum": [
"checkbox",
"date",
"email",
"file",
"number",
"select",
"text",
"textarea",
"singlelistbox",
"doublelistbox",
"table",
"segmentedbutton",
"radio",
"copywell",
"timeinput",
"datepickerrange",
"multilist"
],
"type": "string",
"description": "The default rendering for this field."
},
"defaultValue": {
"type": "string",
"description": "The default value for this field."
},
"displayOptions": {
"type": "object",
"description": "The options that correspond to the display_type."
}
}
}
PolicyTemplateWithDetails
{
"type": "object",
"title": "PolicyTemplateWithDetails",
"properties": {
"id": {
"type": "string",
"description": "ObjectId uniquely identifying a Policy Template."
},
"name": {
"type": "string",
"description": "The unique name for the Policy Template."
},
"behavior": {
"type": "string",
"description": "Specifics about the behavior of the policy."
},
"activation": {
"type": "string",
"description": "Requirements before the policy can be activated."
},
"description": {
"type": "string",
"description": "The default description for the Policy."
},
"displayName": {
"type": "string",
"description": "The default display name for the Policy."
},
"configFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyTemplateConfigField"
},
"description": "An unordered list of all the fields that can be configured for this Policy Template."
},
"osMetaFamily": {
"enum": [
"linux",
"darwin",
"windows",
"ios",
"universal",
"android"
],
"type": "string"
},
"osRestrictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OSRestriction"
}
}
},
"description": "The shallow information about a Policy Template."
}
PolicyUpdateRequest
{
"type": "object",
"title": "PolicyRequest",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The description for this specific Policy."
},
"notes": {
"type": "string",
"description": "The notes for this specific Policy."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyValue"
}
}
},
"description": "A request to update an instance of a policy template."
}
PolicyValue
{
"type": "object",
"title": "PolicyValue",
"properties": {
"value": {
"type": "string",
"items": {},
"description": "The value for the configuration field for this Policy instance."
},
"sensitive": {
"type": "boolean",
"description": "Defines if the value is sensitive or not."
},
"configFieldID": {
"type": "string",
"description": "The ObjectId of the corresponding Policy Template configuration field."
}
}
}
PolicyWithDetails
{
"type": "object",
"title": "PolicyWithDetails",
"properties": {
"id": {
"type": "string",
"description": "ObjectId uniquely identifying a Policy."
},
"name": {
"type": "string",
"description": "The description for this specific Policy."
},
"notes": {
"type": "string",
"description": "The notes for this specific Policy."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyValue"
}
},
"template": {
"$ref": "#/components/schemas/PolicyTemplate"
},
"configFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyTemplateConfigField"
}
}
},
"description": "An instance of a policy template."
}
PolicyresultsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyResult"
}
}
PolicystatusesPoliciesListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyResult"
}
}
PolicystatusesSystemsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyResult"
}
}
PolicytemplatesListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyTemplate"
}
}
Provider
{
"example": {
"id": "5c3536e9e0a6840001872799",
"disallowOrgCreation": true
},
"properties": {
"id": {
"type": "string"
},
"disallowOrgCreation": {
"type": "boolean"
}
}
}
ProviderAdminReq
{
"type": "object",
"title": "ProviderAdminReq",
"example": {
"role": "5c3536e9e0a6840001872799",
"email": "joe@example.com",
"lastname": "Blough",
"roleName": "Administrator",
"firstname": "Joe",
"bindNoOrgs": false,
"enableMultiFactor": true
},
"required": [
"email"
],
"properties": {
"role": {
"type": "string"
},
"email": {
"type": "string"
},
"lastname": {
"type": "string"
},
"roleName": {
"type": "string"
},
"firstname": {
"type": "string"
},
"bindNoOrgs": {
"type": "boolean",
"default": false
},
"apiKeyAllowed": {
"type": "boolean"
},
"enableMultiFactor": {
"type": "boolean"
}
}
}
ProviderInvoice
{
"type": "object",
"title": "ProviderInvoice",
"example": {
"id": "234324",
"status": "Partially Paid",
"dueDate": "2021-08-07",
"currency": "USD",
"amountPaid": "10.9",
"amountBilled": "200.0",
"amountRemaining": "189.1"
},
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"dueDate": {
"type": "string"
},
"currency": {
"type": "string"
},
"amountPaid": {
"type": "string"
},
"amountBilled": {
"type": "string"
},
"amountRemaining": {
"type": "string"
}
},
"description": "Details of a an invoice"
}
ProviderInvoiceResponse
{
"type": "object",
"title": "ProviderInvoiceResponse",
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderInvoice"
}
},
"totalCount": {
"type": "integer"
}
},
"description": "Response for retrieve provider invoices"
}
ProvidersListAdministrators401Response
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ProvidersListAdministratorsResponse
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Administrator"
}
},
"totalCount": {
"type": "integer"
}
}
}
ProvidersListOrganizationsResponse
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Organization"
}
},
"totalCount": {
"type": "integer"
}
}
}
ProvidersPostAdminsResponse
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
ProvidersRetrieveInvoiceResponse
{
"type": "string",
"format": "binary"
}
PushEndpointResponse
{
"type": "object",
"title": "PushEndpointResponse",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"state": {
"type": "string"
},
"device": {
"type": "object",
"properties": {
"os": {
"type": "string"
},
"make": {
"type": "string"
},
"model": {
"type": "string"
},
"osVersion": {
"type": "string"
},
"uvEnabled": {
"type": "boolean"
},
"appVersion": {
"type": "string"
}
}
},
"lastUsedDate": {
"type": "string",
"format": "date-time"
},
"enrollmentDate": {
"type": "string",
"format": "date-time"
}
},
"description": "A push endpoint response from the auth service."
}
PushEndpointsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PushEndpointResponse"
}
}
PushEndpointsPatchRequest
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"state": {
"enum": [
"active",
"inactive"
],
"type": "string"
}
}
}
PushVerificationsStartRequest
{
"type": "object",
"title": "SendVerificationPushRequest represents a create request",
"properties": {
"message": {
"type": "string"
}
}
}
PwmAllUsers
{
"type": "object",
"required": [
"results",
"totalCount"
],
"properties": {
"results": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/PwmUser"
},
{
"$ref": "#/components/schemas/PasswordsSecurity"
}
]
}
},
"totalCount": {
"type": "integer",
"format": "int32",
"example": 50
}
}
}
PwmCloudBackupRestores
{
"type": "object",
"properties": {
"approved": {
"type": "integer",
"format": "int32"
},
"requested": {
"type": "integer",
"format": "int32"
}
}
}
PwmItemHistory
{
"type": "object",
"properties": {
"createdBy": {
"type": "string",
"format": "uuid"
},
"updatedBy": {
"type": "string",
"format": "uuid"
},
"dateCreated": {
"type": "string"
},
"dateUpdated": {
"type": "string"
}
}
}
PwmItemsCountByType
{
"type": "object",
"properties": {
"type": {
"type": "integer",
"format": "int32"
},
"count": {
"type": "integer",
"format": "int32"
}
}
}
PwmItemsMetadata
{
"type": "object",
"required": [
"results",
"totalCount"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PwmItemsCountByType"
}
},
"results": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/PwmUserItem"
},
{
"$ref": "#/components/schemas/PwmItemHistory"
}
]
}
},
"totalCount": {
"type": "integer",
"format": "int32",
"example": 50
}
}
}
PwmOverviewAppVersions
{
"type": "object",
"required": [
"results",
"totalCount"
],
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"version": {
"type": "string",
"example": "1.0.0"
},
"usersCount": {
"type": "integer",
"format": "int32",
"example": 10
}
}
}
},
"totalCount": {
"type": "integer",
"format": "int32",
"example": 50
}
}
}
PwmOverviewMain
{
"type": "object",
"required": [
"sharedFolders",
"pendingInvites",
"totalUsers",
"devices"
],
"properties": {
"devices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"example": 1
},
"name": {
"type": "string",
"example": "ios"
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
}
}
}
},
"totalUsers": {
"type": "integer",
"format": "int32",
"example": 50
},
"oldPasswords": {
"type": "integer",
"format": "int32",
"example": 10
},
"sharedFolders": {
"type": "integer",
"format": "int32",
"example": 50
},
"weakPasswords": {
"type": "integer",
"format": "int32",
"example": 10
},
"enrolledGroups": {
"type": "integer",
"format": "int32"
},
"passwordsCount": {
"type": "integer",
"format": "int32",
"example": 10
},
"passwordsScore": {
"type": "number",
"example": 80.5
},
"pendingInvites": {
"type": "integer",
"format": "int32",
"example": 50
},
"compromisedPasswords": {
"type": "integer",
"format": "int32",
"example": 10
}
}
}
PwmUser
{
"type": "object",
"required": [
"id",
"name",
"email",
"status"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"apps": {
"$ref": "#/components/schemas/Apps"
},
"name": {
"type": "string",
"example": "folder admin"
},
"email": {
"type": "string",
"format": "email"
},
"groups": {
"$ref": "#/components/schemas/Groups"
},
"status": {
"type": "string",
"example": "active"
},
"username": {
"type": "string",
"example": "username1"
},
"externalId": {
"type": "string"
},
"itemsCount": {
"type": "integer",
"format": "int32"
},
"employeeUuid": {
"type": "string",
"format": "uuid"
},
"passwordsCount": {
"type": "integer",
"format": "int32",
"example": 10
},
"passwordsScore": {
"type": "number",
"example": 80.5
},
"scoreUpdatedAt": {
"type": "string"
},
"cloudBackupRestores": {
"$ref": "#/components/schemas/PwmCloudBackupRestores"
}
}
}
PwmUserById
{
"allOf": [
{
"$ref": "#/components/schemas/PwmUser"
},
{
"$ref": "#/components/schemas/PasswordsSecurity"
}
]
}
PwmUserItem
{
"type": "object",
"required": [
"id",
"itemUuid",
"type",
"nickname",
"field1",
"field2"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "integer",
"format": "int32"
},
"field1": {
"type": "string"
},
"field2": {
"type": "string"
},
"itemUuid": {
"type": "string",
"format": "uuid"
},
"nickname": {
"type": "string"
},
"folderName": {
"type": "string",
"example": "folder 1"
},
"folderUuid": {
"type": "string",
"format": "uuid"
}
}
}
PwmUserItems
{
"type": "object",
"required": [
"results",
"totalCount"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PwmItemsCountByType"
}
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PwmUserItem"
}
},
"totalCount": {
"type": "integer",
"format": "int32",
"example": 50
}
}
}
PwmUserSharedFolders
{
"type": "object",
"required": [
"results",
"totalCount"
],
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"usersWithAccess",
"itemsInFolder",
"createdAt"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"example": "folder 1"
},
"createdAt": {
"type": "string"
},
"accessLevelId": {
"type": "string",
"format": "uuid"
},
"itemsInFolder": {
"type": "integer",
"format": "int32",
"example": 15
},
"passwordsScore": {
"type": "number",
"example": 80
},
"scoreUpdatedAt": {
"type": "string"
},
"accessLevelName": {
"type": "string",
"example": "folder admin"
},
"usersWithAccess": {
"type": "integer",
"format": "int32",
"example": 5
}
}
}
},
"totalCount": {
"type": "integer",
"format": "int32",
"example": 50
}
}
}
Query
{
"type": "object",
"title": "Query",
"required": [
"queryType"
],
"properties": {
"queryType": {
"enum": [
"Filter",
"FilterQuery"
],
"type": "string"
}
},
"x-examples": {
"example-1": {
"queryType": "FilterQuery"
}
},
"description": "Basic query.",
"discriminator": {
"propertyName": "queryType"
}
}
QueuedCommandList
{
"type": "object",
"title": "QueuedCommandList",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The workflowInstanceId."
},
"system": {
"type": "string",
"description": "The ID of the device the command is bound to."
},
"command": {
"type": "string",
"description": "The ID of the command, from savedAgentCommands."
},
"pendingCount": {
"type": "integer",
"description": "The number of devices that still haven't received the directive."
}
}
}
},
"totalCount": {
"type": "integer",
"description": "The total number of queued command results."
}
},
"description": "List of queued commands"
}
ScheduleOSUpdate
{
"type": "object",
"required": [
"install_action",
"product_key"
],
"properties": {
"product_key": {
"type": "string"
},
"install_action": {
"$ref": "#/components/schemas/InstallActionType"
},
"max_user_deferrals": {
"type": "integer",
"format": "int32"
}
}
}
SetupAssistantOption
{
"enum": [
"accessibility",
"appearance",
"appleID",
"biometric",
"diagnostics",
"displayTone",
"fileVault",
"icloudDiagnostics",
"icloudStorage",
"location",
"payment",
"privacy",
"restore",
"screenTime",
"siri",
"tos",
"appStore",
"displayZoom",
"deviceToDeviceMigration",
"homeButton",
"imessageAndFacetime",
"messagingActivationUsingPhoneNumber",
"moveFromAndroid",
"passcode",
"restoreComplete",
"setupCellular",
"softwareUpdate",
"unlockWithWatch",
"updateComplete",
"watchMigration",
"welcome"
],
"type": "string",
"title": "Setup Assistant Option",
"description": "Options to skip screens during MacOS and iOS setup:\n* `accessibility` - Skips the Accessibility pane, only if the Mac is connected to Ethernet and the cloud config is downloaded.\n* `appearance` - Skips the Choose Your Look screen.\n* `appleID` - Skips Apple ID setup.\n* `biometric` - Skips biometric setup.\n* `diagnostics` - Skips the App Analytics pane.\n* `displayTone` - Skips display tone setup.\n* `fileVault` - Skips FileVault setup assistant screen.\n* `icloudDiagnostics` - Skips iCloud analytics screen.\n* `icloudStorage` - Skips iCloud documents and desktop screen.\n* `location` - Skips location services setup.\n* `payment` - Skips Apple Pay setup.\n* `privacy` - Skips the Privacy setup.\n* `restore` - Skips restoring from backup.\n* `screenTime` - Skips screen time setup.\n* `siri` - Skips Siri setup.\n* `tos` - Skips terms and conditions.\n* `appStore` - Skips the App Store pane.\n* `deviceToDeviceMigration` - Skips Device to Device Migration pane.\n* `displayZoom` - Skips zoom setup.\n* `homeButton` - Skips the Meet the New Home Button screen on iPhone 7, iPhone 7 Plus, iPhone 8, iPhone 8 Plus and iPhone SE.\n* `imessageAndFacetime` - Skips the iMessage and FaceTime screen in iOS.\n* `messagingActivationUsingPhoneNumber` - Skips the iMessage pane.\n* `moveFromAndroid` - If the Restore pane is not skipped, removes the Move from Android option in the Restore pane on iOS.O\n* `passcode` - Hides and disables the passcode pane.\n* `restoreComplete` - Skips the Restore Completed pane.\n* `setupCellular` - Skips the add cellular plan pane.\n* `softwareUpdate` - Skips the mandatory software update screen in iOS.\n* `unlockWithWatch` - Skips Unlock Your Mac with your Apple Watch pane.\n* `updateComplete` - Skips the Software Update Complete pane.\n* `watchMigration` - Skips the screen for watch migration.\n* `welcome` - Skips the Get Started pane.\n"
}
SharedFolder
{
"type": "object",
"required": [
"uuid",
"name",
"usersWithAccess",
"itemsInFolder",
"createdAt"
],
"properties": {
"name": {
"type": "string",
"example": "folder admin"
},
"uuid": {
"type": "string",
"format": "uuid"
},
"createdAt": {
"type": "string"
},
"itemsInFolder": {
"type": "integer",
"format": "int32",
"example": 15
},
"passwordsCount": {
"type": "integer",
"format": "int32",
"example": 25
},
"passwordsScore": {
"type": "number",
"example": 70.5
},
"scoreUpdatedAt": {
"type": "string"
},
"usersWithAccess": {
"type": "integer",
"format": "int32",
"example": 5
}
}
}
SharedFolderAccessLevels
{
"type": "object",
"required": [
"results"
],
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"example": "folder admin"
},
"description": {
"type": "string",
"example": "folder admin description"
}
}
}
}
}
}
SharedFolderDetails
{
"allOf": [
{
"$ref": "#/components/schemas/SharedFolder"
},
{
"$ref": "#/components/schemas/PasswordsSecurity"
}
]
}
SharedFolderGroups
{
"type": "object",
"required": [
"results",
"totalCount"
],
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupPwm"
}
},
"totalCount": {
"type": "integer",
"format": "int32",
"example": 50
}
}
}
SharedFolderUsers
{
"type": "object",
"required": [
"results",
"totalCount"
],
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"email",
"accessLevelId",
"accessLevelName",
"status"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"apps": {
"$ref": "#/components/schemas/Apps"
},
"name": {
"type": "string",
"example": "folder admin"
},
"email": {
"type": "string",
"format": "email"
},
"status": {
"type": "string",
"example": "active"
},
"username": {
"type": "string",
"example": "username1"
},
"externalId": {
"type": "string"
},
"employeeUuid": {
"type": "string",
"format": "uuid"
},
"accessLevelId": {
"type": "string",
"format": "uuid"
},
"accessLevelName": {
"type": "string",
"example": "folder admin"
}
}
}
},
"totalCount": {
"type": "integer",
"format": "int32",
"example": 50
}
}
}
SharedFoldersList
{
"type": "object",
"required": [
"results",
"totalCount"
],
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SharedFolder"
}
},
"totalCount": {
"type": "integer",
"format": "int32",
"example": 50
}
}
}
SoftwareAppStatusesListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/software-app-status"
}
}
SoftwareAppsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/software-app"
}
}
SoftwareAppsRetryInstallationRequest
{
"type": "object",
"title": "SoftwareAppsRetryInstallationRequest",
"properties": {
"system_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of system IDs to retry the software application installation."
}
}
}
SubscriptionsGetResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/subscription"
}
}
SuggestionCounts
{
"type": "object",
"readOnly": true,
"properties": {
"add": {
"type": "integer"
},
"total": {
"type": "integer"
},
"remove": {
"type": "integer"
}
}
}
SyncroBillingMappingConfigurationOption
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The option name"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SyncroBillingMappingConfigurationOptionValue"
},
"description": "The actual option's values"
}
},
"description": "The representation of a Syncro billing mapping dependency with its name (e.g. schedule) and actual values (e.g. individual schedules)"
}
SyncroBillingMappingConfigurationOptionValue
{
"type": "object",
"properties": {
"label": {
"type": "string"
},
"lines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SyncroBillingMappingConfigurationOptionValueLine"
}
},
"value": {
"type": "integer"
}
},
"description": "The shape of a Syncro billing mapping dependency with its human readable description (label) and value stored in the backend (value) and children (lines)"
}
SyncroBillingMappingConfigurationOptionValueLine
{
"type": "object",
"properties": {
"label": {
"type": "string"
},
"value": {
"type": "integer"
}
},
"description": "The shape of a Syncro billing mapping schedule's line"
}
SyncroBillingMappingConfigurationOptionsResp
{
"type": "object",
"required": [
"options"
],
"properties": {
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SyncroBillingMappingConfigurationOption"
}
}
},
"description": "Response for retrieving Syncro billing mapping configuration options"
}
SyncroCompany
{
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"description": "The company identifier."
},
"name": {
"type": "string",
"description": "The company name."
}
},
"description": "Syncro company details"
}
SyncroCompanyResp
{
"type": "object",
"required": [
"totalCount",
"records"
],
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SyncroCompany"
}
},
"totalCount": {
"type": "integer"
}
},
"description": "Response for retrieving Syncro companies"
}
SyncroCreateConfiguration422Response
{
"type": "object",
"properties": {}
}
SyncroCreateConfigurationResponse
{
"type": "object",
"required": [
"integrationId"
],
"properties": {
"integrationId": {
"type": "string",
"description": "The identifier of the created integration"
}
}
}
SyncroIntegration
{
"type": "object",
"title": "Get Syncro integration GET object",
"required": [
"id",
"subdomain"
],
"properties": {
"id": {
"type": "string",
"description": "The identifier for this Syncro integration."
},
"subdomain": {
"type": "string",
"description": "The subdomain for the URL to connect to Syncro."
},
"isMspAuthConfigured": {
"type": "boolean",
"description": "Has the msp-api been configured with auth data yet"
}
},
"description": "Syncro integration configuration details"
}
SyncroIntegrationPatchReq
{
"type": "object",
"title": "Create Syncro Integration PATCH object",
"properties": {
"apiToken": {
"type": "string",
"description": "The Syncro API token for authentication"
},
"subdomain": {
"type": "string",
"description": "The subdomain for the URL to connect to Syncro."
}
},
"description": "Request for updating a Syncro integration"
}
SyncroIntegrationReq
{
"type": "object",
"title": "Create Syncro Integration POST object",
"required": [
"subdomain",
"apiToken"
],
"properties": {
"apiToken": {
"type": "string",
"description": "The Syncro API token for authentication"
},
"subdomain": {
"type": "string",
"description": "The subdomain for the URL to connect to Syncro."
}
},
"description": "Request for creating a Syncro integration"
}
SyncroMappingRequest
{
"type": "object",
"minItems": 1,
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"organization",
"company"
],
"properties": {
"delete": {
"type": "boolean"
},
"company": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"organization": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string"
}
}
},
"billingConfigurations": {
"type": "object",
"properties": {
"fields": {
"type": "object",
"properties": {
"schedule_id": {
"type": "object",
"properties": {
"kind": {
"type": "string"
},
"numberValue": {
"type": "number"
}
}
},
"line_item_id": {
"type": "object",
"properties": {
"kind": {
"type": "string"
},
"numberValue": {
"type": "number"
}
}
},
"schedule_name": {
"type": "object",
"properties": {
"kind": {
"type": "string"
},
"stringValue": {
"type": "string"
}
}
},
"line_item_name": {
"type": "object",
"properties": {
"kind": {
"type": "string"
},
"stringValue": {
"type": "string"
}
}
}
}
}
},
"description": "Syncro billing mapping details"
}
}
}
}
},
"x-examples": {
"Delete Company Mapping": {
"data": [
{
"delete": true,
"organization": {
"id": "orgId-1",
"name": "OrgId1Name"
}
},
{
"delete": true,
"organization": {
"id": "orgId-2",
"name": "OrgId2Name"
}
},
{
"delete": true,
"organization": {
"id": "orgId-3",
"name": "OrgId3Name"
}
}
]
},
"Create\\Edit Billing Mapping": [
{
"company": {
"id": "syncro-company-id",
"name": "SyncroCompanyName"
},
"organization": {
"id": "newOrganizationId",
"name": "OrganizationName"
},
"billingConfigurations": {
"fields": {
"schedule_id": {
"kind": "numberValue",
"numberValue": 99
},
"line_item_id": {
"kind": "numberValue",
"numberValue": 12
},
"schedule_name": {
"kind": "stringValue",
"stringValue": "SyncroScheduleName"
},
"line_item_name": {
"kind": "stringValue",
"stringValue": "SyncroLineItemName"
}
}
}
}
],
"Create\\Edit Existing Company Mapping": [
{
"company": {
"id": "syncro-company-id",
"name": "SyncroCompanyName"
},
"organization": {
"id": "newOrganizationId",
"name": "OrganizationName"
}
}
]
},
"description": "Request object for creating Syncro mappings"
}
SyncroMappingResponse
{
"type": "object",
"title": "SyncroMappingResponse",
"properties": {
"company": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"organization": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"description": "Syncro mapping GET response"
}
SyncroRetrieveMappingsResponse
{
"type": "object",
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SyncroMappingResponse"
}
},
"totalCount": {
"type": "number"
}
}
}
SyncroSettings
{
"type": "object",
"title": "Get Syncro integration settings GET object",
"properties": {
"automaticTicketing": {
"type": "boolean",
"description": "Determine whether Syncro uses automatic ticketing"
}
},
"description": "Syncro integration settings"
}
SyncroSettingsPatchReq
{
"type": "object",
"title": "Update Syncro Integration's Settings PATCH object",
"properties": {
"automaticTicketing": {
"type": "boolean",
"description": "Determine whether Syncro uses automatic ticketing"
}
},
"x-examples": {
"example-1": {
"automaticTicketing": true
}
},
"description": "Request for updating a Syncro integration's settings"
}
SyncroTicketingAlertConfiguration
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"status": {
"type": "string"
},
"userId": {
"type": "integer"
},
"dueDays": {
"type": "integer"
},
"category": {
"type": "string"
},
"priority": {
"type": "string"
},
"username": {
"type": "string"
},
"description": {
"type": "string"
},
"displayName": {
"type": "string"
},
"problemType": {
"type": "string"
},
"shouldCreateTickets": {
"type": "boolean"
}
},
"description": "A SyncroTicketingAlertConfiguration object"
}
SyncroTicketingAlertConfigurationList
{
"type": "object",
"required": [
"records"
],
"properties": {
"records": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"alertId": {
"type": "string"
}
}
},
{
"$ref": "#/components/schemas/SyncroTicketingAlertConfiguration"
}
]
}
}
}
}
SyncroTicketingAlertConfigurationOption
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"value": {
"type": "integer"
}
}
}
}
}
}
SyncroTicketingAlertConfigurationOptions
{
"type": "object",
"required": [
"records"
],
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SyncroTicketingAlertConfigurationOption"
}
}
}
}
SyncroTicketingAlertConfigurationRequest
{
"type": "object",
"required": [
"shouldCreateTickets",
"problemType"
],
"properties": {
"status": {
"type": "string"
},
"userId": {
"type": "number"
},
"dueDays": {
"type": "integer"
},
"priority": {
"type": "string"
},
"username": {
"type": "string"
},
"problemType": {
"type": "string"
},
"shouldCreateTickets": {
"type": "boolean"
}
},
"description": "A SyncroTicketingAlertConfigurationRequest to update Syncro ticketing configuration."
}
SyncroUpdateConfigurationResponse
{
"type": "object",
"properties": {}
}
SystemGroup
{
"type": "object",
"title": "SystemGroup",
"properties": {
"id": {
"type": "string",
"description": "ObjectId uniquely identifying a System Group."
},
"name": {
"type": "string",
"description": "Display name of a System Group."
},
"type": {
"enum": [
"system_group"
],
"type": "string",
"description": "The type of the group; always 'system' for a System Group."
},
"email": {
"type": "string",
"description": "E-mail address associated with a System Group"
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
},
"description": {
"type": "string",
"description": "Description of a System Group"
},
"memberQuery": {
"$ref": "#/components/schemas/MemberQuery"
},
"membershipMethod": {
"$ref": "#/components/schemas/GroupMembershipMethodType"
},
"memberQueryExemptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObject"
},
"description": "Array of GraphObjects exempted from the query"
},
"memberSuggestionsNotify": {
"type": "boolean",
"description": "True if notification emails are to be sent for membership suggestions."
}
}
}
SystemGroupPost
{
"type": "object",
"title": "SystemGroupPost",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Display name of a System Group."
},
"email": {
"type": "string",
"description": "Email address of a System Group"
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
},
"description": {
"type": "string",
"description": "Description of a System Group"
},
"memberQuery": {
"$ref": "#/components/schemas/MemberQuery"
},
"membershipMethod": {
"$ref": "#/components/schemas/GroupMembershipMethodType"
},
"memberQueryExemptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObject"
},
"description": "Array of GraphObjects exempted from the query"
},
"memberSuggestionsNotify": {
"type": "boolean",
"description": "True if notification emails are to be sent for membership suggestions."
}
}
}
SystemGroupPut
{
"type": "object",
"title": "SystemGroupPut",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Display name of a System Group."
},
"email": {
"type": "string",
"description": "Email address of a System Group"
},
"attributes": {
"$ref": "#/components/schemas/GraphAttributes"
},
"description": {
"type": "string",
"description": "Description of a System Group"
},
"memberQuery": {
"$ref": "#/components/schemas/MemberQuery"
},
"membershipMethod": {
"$ref": "#/components/schemas/GroupMembershipMethodType"
},
"memberQueryExemptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObject"
},
"description": "Array of GraphObjects exempted from the query"
},
"memberSuggestionsNotify": {
"type": "boolean",
"description": "True if notification emails are to be sent for membership suggestions."
}
}
}
SystemGroupsApplySuggestionsRequest
{
"type": "object",
"properties": {
"object_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-examples": {
"example-1": {
"object_ids": [
"212345678901234567890123",
"123456789012345678901234"
]
}
}
}
SystemGroupsApplySuggestionsResponse
{
"type": "object",
"example": {},
"properties": {}
}
SystemGroupsListAllResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SystemGroup"
}
}
SystemGroupsListSuggestionsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberSuggestion"
}
}
SystemInsightsGetChassisInfo400Response
{
"type": "string"
}
SystemInsightsGetChassisInfoResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-chassis-info"
}
}
SystemInsightsGetDiskInfoResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-disk-info"
}
}
SystemInsightsGetIeExtensionsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-ie-extensions"
}
}
SystemInsightsGetKernelInfoResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-kernel-info"
}
}
SystemInsightsGetOsVersionResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-os-version"
}
}
SystemInsightsGetSipConfigResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-sip-config"
}
}
SystemInsightsGetSystemInfoListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-system-info"
}
}
SystemInsightsGetTpmInfo400Response
{
"type": "string"
}
SystemInsightsGetTpmInfoResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-tpm-info"
}
}
SystemInsightsGetUserGroupsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-user-groups"
}
}
SystemInsightsListAlfExceptionsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-alf-exceptions"
}
}
SystemInsightsListAlfExplicitAuthsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-alf-explicit-auths"
}
}
SystemInsightsListAlfResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-alf"
}
}
SystemInsightsListAppcompatShimsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-appcompat-shims"
}
}
SystemInsightsListAppsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-apps"
}
}
SystemInsightsListAuthorizedKeysResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-authorized-keys"
}
}
SystemInsightsListAzureInstanceMetadata400Response
{
"type": "string"
}
SystemInsightsListAzureInstanceMetadataResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-azure-instance-metadata"
}
}
SystemInsightsListAzureInstanceTags400Response
{
"type": "string"
}
SystemInsightsListAzureInstanceTagsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-azure-instance-tags"
}
}
SystemInsightsListBatteryDataResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-battery"
}
}
SystemInsightsListBitlockerInfoResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-bitlocker-info"
}
}
SystemInsightsListBrowserPluginsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-browser-plugins"
}
}
SystemInsightsListCertificatesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-certificates"
}
}
SystemInsightsListChromeExtensionsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-chrome-extensions"
}
}
SystemInsightsListConnectivityResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-connectivity"
}
}
SystemInsightsListCrashesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-crashes"
}
}
SystemInsightsListCupsDestinationsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-cups-destinations"
}
}
SystemInsightsListDiskEncryptionResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-disk-encryption"
}
}
SystemInsightsListDnsResolversResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-dns-resolvers"
}
}
SystemInsightsListEtcHostsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-etc-hosts"
}
}
SystemInsightsListFirefoxAddonsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-firefox-addons"
}
}
SystemInsightsListGroupsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-groups"
}
}
SystemInsightsListInterfaceAddressesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-interface-addresses"
}
}
SystemInsightsListInterfaceDetailsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-interface-details"
}
}
SystemInsightsListLaunchdResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-launchd"
}
}
SystemInsightsListLinuxPackagesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-linux-packages"
}
}
SystemInsightsListLoggedInUsersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-logged-in-users"
}
}
SystemInsightsListLogicalDrivesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-logical-drives"
}
}
SystemInsightsListManagedPoliciesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-managed-policies"
}
}
SystemInsightsListMountsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-mounts"
}
}
SystemInsightsListPatchesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-patches"
}
}
SystemInsightsListProgramsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-programs"
}
}
SystemInsightsListPythonPackagesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-python-packages"
}
}
SystemInsightsListSafariExtensionsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-safari-extensions"
}
}
SystemInsightsListScheduledTasksResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-scheduled-tasks"
}
}
SystemInsightsListSecureBoot400Response
{
"type": "string"
}
SystemInsightsListSecureBootResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-secureboot"
}
}
SystemInsightsListServicesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-services"
}
}
SystemInsightsListShadowDataResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-shadow"
}
}
SystemInsightsListSharedFoldersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-shared-folders"
}
}
SystemInsightsListSharedResourcesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-shared-resources"
}
}
SystemInsightsListSharingPreferencesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-sharing-preferences"
}
}
SystemInsightsListStartupItemsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-startup-items"
}
}
SystemInsightsListSystemControlsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-system-controls"
}
}
SystemInsightsListUptimeResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-uptime"
}
}
SystemInsightsListUsbDevicesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-usb-devices"
}
}
SystemInsightsListUserAssist400Response
{
"type": "string"
}
SystemInsightsListUserAssistResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-userassist"
}
}
SystemInsightsListUserSshKeysResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-user-ssh-keys"
}
}
SystemInsightsListUsersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-users"
}
}
SystemInsightsListWifiNetworksResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-wifi-networks"
}
}
SystemInsightsListWifiStatusResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-wifi-status"
}
}
SystemInsightsListWindowsSecurityCenter400Response
{
"type": "string"
}
SystemInsightsListWindowsSecurityCenterResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-windows-security-center"
}
}
SystemInsightsListWindowsSecurityProductsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-windows-security-products"
}
}
SystemsListSoftwareAppsWithStatusesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/software-app-with-status"
}
}
SystemsOrgSettingsSetDefaultPasswordSyncSettings204Response
{
"type": "object",
"example": {},
"properties": {}
}
SystemsOrgSettingsSetDefaultPasswordSyncSettingsResponse
{
"type": "object",
"properties": {}
}
SystemsOrgSettingsSetSignInWithJumpCloudSettings204Response
{
"type": "object",
"example": {},
"properties": {}
}
SystemsOrgSettingsSetSignInWithJumpCloudSettingsResponse
{
"type": "object",
"properties": {}
}
TicketingIntegrationAlert
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"category": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
TicketingIntegrationAlertsResp
{
"type": "object",
"required": [
"records"
],
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TicketingIntegrationAlert"
}
}
}
}
TranslationRulesGSuiteListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GSuiteTranslationRule"
}
}
TranslationRulesOffice365ListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Office365TranslationRule"
}
}
User
{
"type": "object",
"title": "User",
"properties": {
"email": {
"type": "string",
"maxLength": 1024
},
"company": {
"type": "string",
"maxLength": 1024
},
"jobTitle": {
"type": "string",
"maxLength": 1024
},
"lastname": {
"type": "string",
"maxLength": 1024
},
"location": {
"type": "string",
"maxLength": 1024
},
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Address"
}
},
"firstname": {
"type": "string",
"maxLength": 1024
},
"costCenter": {
"type": "string",
"maxLength": 1024
},
"department": {
"type": "string",
"maxLength": 1024
},
"employeeType": {
"type": "string",
"maxLength": 1024
},
"phoneNumbers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PhoneNumber"
}
},
"alternateEmail": {
"type": "string"
},
"employeeIdentifier": {
"type": "string",
"maxLength": 256,
"description": "Must be unique per user."
}
}
}
UserGroup
{
"type": "object",
"title": "UserGroup",
"properties": {
"id": {
"type": "string",
"description": "ObjectId uniquely identifying a User Group."
},
"name": {
"type": "string",
"description": "Display name of a User Group."
},
"type": {
"enum": [
"user_group"
],
"type": "string",
"description": "The type of the group."
},
"email": {
"type": "string",
"description": "Email address of a User Group"
},
"attributes": {
"$ref": "#/components/schemas/GroupAttributes-UserGroup"
},
"description": {
"type": "string",
"description": "Description of a User Group"
},
"memberQuery": {
"$ref": "#/components/schemas/MemberQuery"
},
"membershipMethod": {
"$ref": "#/components/schemas/GroupMembershipMethodType"
},
"suggestionCounts": {
"$ref": "#/components/schemas/SuggestionCounts"
},
"memberQueryExemptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObject"
},
"description": "Array of GraphObjects exempted from the query"
},
"memberSuggestionsNotify": {
"type": "boolean",
"description": "True if notification emails are to be sent for membership suggestions."
}
}
}
UserGroupPost
{
"type": "object",
"title": "UserGroupPost",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Display name of a User Group."
},
"email": {
"type": "string",
"description": "Email address of a User Group"
},
"attributes": {
"$ref": "#/components/schemas/GroupAttributes-UserGroup"
},
"description": {
"type": "string",
"description": "Description of a User Group"
},
"memberQuery": {
"$ref": "#/components/schemas/MemberQuery"
},
"membershipMethod": {
"$ref": "#/components/schemas/GroupMembershipMethodType"
},
"memberQueryExemptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObject"
},
"description": "Array of GraphObjects exempted from the query"
},
"memberSuggestionsNotify": {
"type": "boolean",
"description": "True if notification emails are to be sent for membership suggestions."
}
}
}
UserGroupPut
{
"type": "object",
"title": "UserGroupPut",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Display name of a User Group."
},
"email": {
"type": "string",
"description": "Email address of a User Group"
},
"attributes": {
"$ref": "#/components/schemas/GroupAttributes-UserGroup"
},
"description": {
"type": "string",
"description": "Description of a User Group"
},
"memberQuery": {
"$ref": "#/components/schemas/MemberQuery"
},
"membershipMethod": {
"$ref": "#/components/schemas/GroupMembershipMethodType"
},
"memberQueryExemptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObject"
},
"description": "Array of GraphObjects exempted from the query"
},
"memberSuggestionsNotify": {
"type": "boolean",
"description": "True if notification emails are to be sent for membership suggestions."
}
}
}
UserGroupsApplySuggestionsRequest
{
"type": "object",
"properties": {
"user_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-examples": {
"example-1": {
"user_ids": [
"212345678901234567890123",
"123456789012345678901234"
]
}
}
}
UserGroupsApplySuggestionsResponse
{
"type": "object",
"example": {},
"properties": {}
}
UserGroupsGetSuggestionsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberSuggestion"
}
}
UserGroupsListAllResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/UserGroup"
}
}
WorkdaysImportresultsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/job-workresult"
}
}
WorkdaysListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/workday-output"
}
}
WorkdaysWorkersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/workday-worker"
}
}
active-directory
{
"type": "object",
"title": "Active Directory",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "ObjectID of this Active Directory instance."
},
"domain": {
"type": "string",
"description": "Domain name for this Active Directory instance."
},
"useCase": {
"enum": [
"UNSET",
"TWOWAYSYNC",
"JCASAUTHORITY",
"ADASAUTHORITY"
],
"type": "string"
},
"primaryAgent": {
"type": "string",
"readOnly": true,
"description": "ObjectID of the primary agent of domain."
}
}
}
active-directory-agent
{
"type": "object",
"title": "Active Directory Agent",
"properties": {
"agentType": {
"enum": [
"SYNC",
"IMPORT"
],
"type": "string"
}
}
}
active-directory-agent-get
{
"type": "object",
"title": "Active Directory Agent Get",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "ObjectID of this Active Directory Agent."
},
"state": {
"enum": [
"unsealed",
"active",
"inactive"
],
"type": "string"
},
"version": {
"type": "string"
},
"hostname": {
"type": "string"
},
"contactAt": {
"type": "string"
},
"source_ip": {
"type": "string"
},
"connectKey": {
"type": "string",
"description": "The connect key to use when installing the Agent on a Domain Controller."
}
}
}
active-directory-agent-list
{
"type": "object",
"title": "Active Directory Agent List",
"properties": {
"id": {
"type": "string",
"description": "ObjectID of this Active Directory Agent."
},
"state": {
"enum": [
"unsealed",
"active",
"inactive"
],
"type": "string"
},
"version": {
"type": "string"
},
"hostname": {
"type": "string"
},
"contactAt": {
"type": "string"
},
"source_ip": {
"type": "string"
}
}
}
apple-mdm-device
{
"type": "object",
"title": "Apple MDM Device",
"x-tags": [
"Apple MDM"
],
"properties": {
"id": {
"type": "string"
},
"udid": {
"type": "string"
},
"enrolled": {
"type": "boolean"
},
"createdAt": {
"type": "string"
},
"osVersion": {
"type": "string"
},
"securityInfo": {
"$ref": "#/components/schemas/apple-mdm-device-security-info"
},
"serialNumber": {
"type": "string"
},
"depRegistered": {
"type": "boolean"
},
"deviceInformation": {
"$ref": "#/components/schemas/apple-mdm-device-info"
},
"hasActivationLockBypassCodes": {
"type": "boolean"
}
}
}
apple-mdm-device-info
{
"type": "object",
"title": "Apple MDM Device Info",
"x-tags": [
"Apple MDM"
],
"properties": {
"imei": {
"type": "string"
},
"iccid": {
"type": "string"
},
"wifiMac": {
"type": "string"
},
"modelName": {
"type": "string"
},
"deviceName": {
"type": "string"
},
"secondImei": {
"type": "string"
},
"secondIccid": {
"type": "string"
},
"isSupervised": {
"type": "boolean"
},
"deviceCapacity": {
"type": "number"
},
"availableDeviceCapacity": {
"type": "number"
},
"subscriberCarrierNetwork": {
"type": "string"
},
"secondSubscriberCarrierNetwork": {
"type": "string"
},
"activationLockAllowedWhileSupervised": {
"type": "boolean"
}
},
"description": "Apple MDM device information"
}
apple-mdm-device-security-info
{
"type": "object",
"title": "Apple MDM Device Security Info",
"x-tags": [
"Apple MDM"
],
"properties": {
"enrolledViaDep": {
"type": "boolean"
},
"passcodePresent": {
"type": "boolean"
},
"isUserEnrollment": {
"type": "boolean"
},
"userApprovedEnrollment": {
"type": "boolean"
},
"isActivationLockManageable": {
"type": "boolean"
}
},
"description": "Apple MDM device security information"
}
apple-mdm-patch
{
"type": "object",
"title": "Apple MDM Patch",
"properties": {
"dep": {
"$ref": "#/components/schemas/DEP"
},
"ades": {
"$ref": "#/components/schemas/ADES"
},
"name": {
"type": "string",
"maxLength": 255,
"description": "A new name for the Apple MDM configuration."
},
"appleSignedCert": {
"type": "string",
"description": "A signed certificate obtained from Apple after providing Apple with the plist file provided on POST."
},
"defaultSystemGroupID": {
"type": "string",
"description": "ObjectId uniquely identifying the MDM default System Group."
},
"appleCertCreatorAppleID": {
"type": "string",
"description": "The Apple ID of the admin who created the Apple signed certificate."
},
"encryptedDepServerToken": {
"type": "string",
"description": "The S/MIME encoded DEP Server Token returned by Apple Business Manager when creating an MDM instance."
},
"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."
}
}
}
apple-mdm-public-key-cert
{
"type": "string",
"title": "Apple MDM Public Key Certificate"
}
apple-mdm-signed-csr-plist
{
"type": "string",
"title": "Apple MDM Signed CSR PList"
}
auth-info
{
"type": "object",
"title": "Auth Info",
"properties": {
"expiry": {
"type": "string"
},
"isValid": {
"type": "boolean"
},
"message": {
"type": "string"
}
}
}
auth-input
{
"type": "object",
"title": "Auth Input",
"properties": {
"basic": {
"type": "object",
"properties": {
"password": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"oauth": {
"type": "object",
"properties": {
"code": {
"type": "string"
}
}
}
}
}
auth-input-object
{
"type": "object",
"title": "Auth Input Object",
"example": {
"auth": {
"basic": {
"password": "mollit cillum",
"username": "veniam dolore"
},
"oauth": {
"code": "minim ad ea dolor"
}
}
},
"properties": {
"auth": {
"$ref": "#/components/schemas/auth-input"
}
}
}
bulk-scheduled-statechange-create
{
"type": "object",
"title": "Bulk Schedule User State Change Create",
"required": [
"user_ids",
"state",
"start_date"
],
"properties": {
"state": {
"enum": [
"ACTIVATED",
"SUSPENDED"
],
"type": "string",
"description": "The state to move the user(s) to"
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of system user ids to schedule for a state change"
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "Date and time that scheduled action should occur"
},
"send_activation_emails": {
"type": "boolean",
"description": "Set to true to send activation or welcome email(s) to each user_id upon activation. Set to false to suppress emails. Can only be used with scheduled activation(s)."
},
"activation_email_override": {
"type": "string",
"description": "Send the activation or welcome email to the specified email address upon activation. Can only be used with a single user_id and scheduled activation. This field will be ignored if `send_activation_emails` is explicitly set to false."
}
},
"x-examples": {
"example-1": {
"state": "SUSPENDED",
"user_ids": [
"666f6f2d6261722d71757578",
"0123456789ab0123456789ab",
"666f6f2d6261722d71757555"
],
"start_date": "2020-01-01T02:00:00"
},
"example-2": {
"state": "ACTIVATED",
"user_ids": [
"666f6f2d6261722d71757578",
"0123456789ab0123456789ab",
"666f6f2d6261722d71757555"
],
"start_date": "2020-01-01T02:00:00",
"send_activation_emails": true
},
"example-3": {
"state": "ACTIVATED",
"user_ids": [
"666f6f2d6261722d71757578"
],
"start_date": "2020-01-01T02:00:00",
"activation_email_override": "alternate-activation-email@email.com"
}
},
"description": "Model to support bulk scheduling of a state change for one or more users"
}
bulk-user-create
{
"type": "object",
"title": "Bulk User Create",
"properties": {
"email": {
"type": "string"
},
"lastname": {
"type": "string"
},
"username": {
"type": "string"
},
"firstname": {
"type": "string"
},
"attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Map of additional attributes."
}
},
"description": "See [V1 system user creation](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_post) for full list of attributes."
}
bulk-user-expire
{
"type": "object",
"title": "Bulk User Expire",
"properties": {
"id": {
"type": "string",
"description": "Object ID of the systemuser to expire"
},
"attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Map of additional attributes."
},
"organization": {
"type": "string",
"description": "The identifier for an organization to link this systemuser to"
}
}
}
bulk-user-unlock
{
"type": "object",
"title": "Bulk User Unlock",
"properties": {
"id": {
"type": "string",
"description": "Object ID of the systemuser to unlock"
},
"attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Map of additional attributes."
},
"organization": {
"type": "string",
"description": "The identifier for an organization to link this systemuser"
}
}
}
bulk-user-update
{
"type": "object",
"title": "Bulk User Update",
"properties": {
"id": {
"type": "string",
"description": "Object ID of the user being updated"
},
"email": {
"type": "string"
},
"lastname": {
"type": "string"
},
"username": {
"type": "string"
},
"firstname": {
"type": "string"
},
"attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Map of additional attributes."
},
"organization": {
"type": "string",
"description": "Organization object id of the user"
}
},
"description": "See [V1 system user update](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_put) for full list of attributes."
}
commandsGraphObjectWithPaths
{
"type": "object",
"title": "commandsGraphObjectWithPaths",
"required": [
"type",
"id",
"paths"
],
"properties": {
"id": {
"type": "string",
"description": "Object ID of this graph object."
},
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/GraphType"
},
"paths": {
"type": "array",
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphConnection"
}
},
"description": "A path through the graph between two graph objects."
},
"command": {
"type": "string"
},
"timeout": {
"type": "string"
},
"schedule": {
"type": "string"
},
"launchType": {
"type": "string"
},
"commandType": {
"type": "string"
},
"organization": {
"type": "string"
},
"timeToLiveSeconds": {
"type": "integer"
},
"compiledAttributes": {
"$ref": "#/components/schemas/GraphAttributes"
},
"scheduleRepeatType": {
"type": "string"
}
}
}
defaultDomain
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"domain": {
"type": "string",
"readOnly": true
}
}
}
device_package.v1.Device
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"osName": {
"type": "string"
},
"userUuid": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"publicKey": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"appVersion": {
"type": "string"
}
}
}
device_package.v1.ListDevicesResponse
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/device_package.v1.Device"
}
},
"totalCount": {
"type": "integer",
"format": "int32"
}
}
}
devices.AggregatedPolicyCount
{
"type": "object",
"title": "Responses",
"properties": {
"total": {
"type": "integer",
"format": "int64",
"description": "the count of all the policies attached to the system."
},
"failed": {
"type": "integer",
"format": "int64",
"description": "the count of failing policies."
},
"pending": {
"type": "integer",
"format": "int64",
"description": "the count of pending policies."
},
"success": {
"type": "integer",
"format": "int64",
"description": "the count of successful policies."
},
"duplicate": {
"type": "integer",
"format": "int64",
"description": "the count of duplicate policies."
},
"unsupportedOs": {
"type": "integer",
"format": "int64",
"description": "the count of policies for which os is unsupported."
}
}
}
devices.AggregatedPolicyResultResponse
{
"type": "object",
"properties": {
"failedPolicies": {
"type": "array",
"items": {
"type": "string"
}
},
"pendingPolicies": {
"type": "array",
"items": {
"type": "string"
}
},
"policyCountData": {
"$ref": "#/components/schemas/devices.AggregatedPolicyCount"
}
}
}
devices.GetDefaultPasswordSyncSettingsResponse
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
}
}
devices.GetSignInWithJumpCloudSettingsResponse
{
"type": "object",
"properties": {
"settings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/devices.SignInWithJumpCloudSetting"
}
},
"organizationObjectId": {
"type": "string",
"format": "byte"
}
}
}
devices.SetDefaultPasswordSyncSettingsRequest
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"organizationObjectId": {
"type": "string",
"format": "byte"
}
}
}
devices.SetSignInWithJumpCloudSettingsRequest
{
"type": "object",
"properties": {
"settings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/devices.SignInWithJumpCloudSetting"
}
},
"organizationObjectId": {
"type": "string",
"format": "byte"
}
}
}
devices.SignInWithJumpCloudSetting
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"osFamily": {
"$ref": "#/components/schemas/devices.SignInWithJumpCloudSetting.OSFamily"
},
"defaultPermission": {
"$ref": "#/components/schemas/devices.SignInWithJumpCloudSetting.Permission"
}
}
}
devices.SignInWithJumpCloudSetting.OSFamily
{
"enum": [
"UNKNOWN",
"WINDOWS",
"MACOS"
],
"type": "string",
"default": "UNKNOWN"
}
devices.SignInWithJumpCloudSetting.Permission
{
"enum": [
"STANDARD",
"ADMIN"
],
"type": "string",
"default": "STANDARD"
}
feature
{
"type": "object",
"properties": {
"name": {
"enum": [
"cloudDirectory",
"cloudInsights",
"deviceManagement",
"directoryInsightsPremium",
"federatedDeviceIdentity",
"implementationQuickstart",
"jcManagedDeviceIdentity",
"jumpcloudGo",
"jumpcloudProtect",
"ldap",
"mdm",
"mfa",
"osPatchManagement",
"passwordManagement",
"premiumSupport",
"primePass",
"radius",
"remoteAccess",
"sso",
"systemInsights",
"userLifecycle",
"zeroTrust"
],
"type": "string",
"description": "The unique identifier for this feature."
}
},
"description": "A feature represents JumpCloud functionality."
}
google.protobuf.Any
{
"type": "object",
"properties": {
"@type": {
"type": "string",
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
}
},
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n\nExample 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\nExample 4: Pack and unpack a message in Go\n\n foo := &pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := &pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": <string>,\n \"lastName\": <string>\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }",
"additionalProperties": {}
}
google.rpc.Status
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/google.protobuf.Any"
}
},
"message": {
"type": "string"
}
}
}
gsuite
{
"type": "object",
"title": "GSuite",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"defaultDomain": {
"$ref": "#/components/schemas/defaultDomain"
},
"groupsEnabled": {
"type": "boolean"
},
"userLockoutAction": {
"enum": [
"suspend",
"maintain"
],
"type": "string"
},
"userPasswordExpirationAction": {
"enum": [
"suspend",
"maintain",
"remove_access"
],
"type": "string"
}
}
}
importUser
{
"type": "object",
"title": "Import User",
"properties": {
"id": {
"type": "string"
},
"email": {
"type": "string"
},
"company": {
"type": "string"
},
"manager": {
"type": "string"
},
"jobTitle": {
"type": "string"
},
"lastname": {
"type": "string"
},
"location": {
"type": "string"
},
"username": {
"type": "string"
},
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/importUserAddress"
}
},
"firstname": {
"type": "string"
},
"costCenter": {
"type": "string"
},
"department": {
"type": "string"
},
"middlename": {
"type": "string"
},
"displayname": {
"type": "string"
},
"employeeType": {
"type": "string"
},
"phoneNumbers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/importUserPhoneNumber"
}
},
"alternateEmail": {
"type": "string"
},
"employeeIdentifier": {
"type": "string"
}
}
}
importUserAddress
{
"type": "object",
"title": "Import User Address",
"properties": {
"type": {
"type": "string"
},
"region": {
"type": "string"
},
"country": {
"type": "string"
},
"locality": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"streetAddress": {
"type": "string"
}
}
}
importUserPhoneNumber
{
"type": "object",
"title": "Import User Address",
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
importUsersResponse
{
"type": "object",
"title": "Import Users Response",
"properties": {
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/importUser"
}
},
"total_count": {
"type": "number"
}
}
}
job-id
{
"type": "object",
"title": "Job ID",
"properties": {
"jobId": {
"type": "string"
}
},
"x-examples": {
"example-1": {
"jobId": "string"
}
}
}
job-workresult
{
"type": "object",
"title": "Job WorkResult",
"properties": {
"id": {
"type": "string"
},
"meta": {
"type": "object"
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"statusMsg": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"persistedFields": {
"type": "object"
}
}
}
jumpcloud.auth.PushVerification
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/jumpcloud.auth.PushVerification.Status"
},
"expiresAt": {
"type": "string",
"format": "date-time"
},
"initiatedAt": {
"type": "string",
"format": "date-time"
},
"userObjectId": {
"type": "string",
"format": "byte"
},
"failureStatus": {
"$ref": "#/components/schemas/google.rpc.Status"
},
"pushEndpointId": {
"type": "string",
"format": "byte"
},
"confirmationCode": {
"type": "string"
}
}
}
jumpcloud.auth.PushVerification.Status
{
"enum": [
"SENT",
"ACCEPTED",
"EXPIRED",
"DENIED",
"ERRORED"
],
"type": "string",
"default": "SENT"
}
jumpcloud.gapps.CreateScheduledResponse
{
"type": "object",
"properties": {
"scheduledJobId": {
"type": "string",
"format": "hex",
"description": "ObjectID of the created Scheduled Job"
}
}
}
jumpcloud.gapps.Domain
{
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "name of the domain"
},
"default": {
"type": "boolean",
"description": "Suggests if the domain is default"
},
"objectId": {
"type": "string",
"format": "byte",
"description": "Unique identifier of the Domain."
},
"accountObjectId": {
"type": "string",
"format": "byte",
"description": "Unique identifier of the GSuite."
}
}
}
jumpcloud.gapps.DomainListResponse
{
"type": "object",
"properties": {
"domains": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jumpcloud.gapps.Domain"
}
},
"totalCount": {
"type": "integer",
"format": "int64"
}
}
}
jumpcloud.gapps.DomainResponse
{
"type": "object",
"properties": {
"domain": {
"$ref": "#/components/schemas/jumpcloud.gapps.Domain"
}
}
}
jumpcloud.gapps.ListScheduledResponse
{
"type": "object",
"properties": {
"schedules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jumpcloud.gapps.ScheduledImport"
}
}
}
}
jumpcloud.gapps.ScheduledImport
{
"type": "object",
"properties": {
"scheduledJobId": {
"type": "string",
"format": "hex",
"description": "ObjectID of the Scheduled Job"
}
}
}
jumpcloud.google_emm.AllowPersonalUsage
{
"enum": [
"PERSONAL_USAGE_ALLOWED",
"PERSONAL_USAGE_DISALLOWED",
"DEDICATED_DEVICE"
],
"type": "string",
"title": "Controls whether personal usage is allowed on a device provisioned\nRefer https://developers.google.com/android/management/reference/rest/v1/enterprises.enrollmentTokens",
"default": "PERSONAL_USAGE_ALLOWED"
}
jumpcloud.google_emm.CommandResponse
{
"type": "object"
}
jumpcloud.google_emm.CommonCriteriaModeInfo
{
"type": "object",
"properties": {
"commonCriteriaModeStatus": {
"type": "string"
}
}
}
jumpcloud.google_emm.ConnectionStatus
{
"type": "object",
"properties": {
"isConnected": {
"type": "boolean"
},
"enterpriseId": {
"type": "string",
"format": "byte"
},
"organizationObjectId": {
"type": "string",
"format": "byte"
}
}
}
jumpcloud.google_emm.CreateEnrollmentTokenRequest
{
"type": "object",
"properties": {
"duration": {
"type": "string",
"title": "duration format as mentioned in https://developers.google.com/android/management/reference/rest/v1/enterprises.enrollmentTokens"
},
"zeroTouch": {
"type": "boolean"
},
"displayName": {
"type": "string",
"title": "Name as set by admin"
},
"oneTimeOnly": {
"type": "boolean",
"title": "If the flag is set to true, only one device can use generated token for\nenrollment"
},
"createdWhere": {
"$ref": "#/components/schemas/jumpcloud.google_emm.CreatedWhere"
},
"userObjectId": {
"type": "string",
"format": "byte"
},
"enrollmentType": {
"$ref": "#/components/schemas/jumpcloud.google_emm.EnrollmentType"
},
"allowPersonalUsage": {
"$ref": "#/components/schemas/jumpcloud.google_emm.AllowPersonalUsage"
},
"enterpriseObjectId": {
"type": "string",
"format": "byte"
},
"provisioningExtras": {
"$ref": "#/components/schemas/jumpcloud.google_emm.ProvisioningExtras"
}
}
}
jumpcloud.google_emm.CreateEnrollmentTokenResponse
{
"type": "object",
"title": "Logging only expiration time of the token. others contain enrollment token information",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"metadata": {
"type": "string"
},
"qrCodeImage": {
"type": "string",
"format": "byte"
},
"enrollmentLink": {
"type": "string"
},
"expirationTime": {
"type": "string"
}
}
}
jumpcloud.google_emm.CreateEnterpriseRequest
{
"type": "object",
"properties": {
"signupUrlName": {
"type": "string",
"title": "not logging because it contains sensitive information"
},
"enrollmentToken": {
"type": "string",
"title": "not logging because it contains sensitive information"
}
}
}
jumpcloud.google_emm.CreateWebTokenRequest
{
"type": "object",
"properties": {
"iframeFeature": {
"$ref": "#/components/schemas/jumpcloud.google_emm.Feature"
},
"parentFrameUrl": {
"type": "string"
},
"enterpriseObjectId": {
"type": "string",
"format": "byte"
}
}
}
jumpcloud.google_emm.CreatedWhere
{
"enum": [
"API",
"ADMIN_PORTAL",
"USER_PORTAL"
],
"type": "string",
"title": "Identifies where create enrollment token request originated",
"default": "API"
}
jumpcloud.google_emm.DeleteEnrollmentTokenResponse
{
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
jumpcloud.google_emm.Device
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"deviceId": {
"type": "string",
"format": "byte"
},
"deviceInformation": {
"$ref": "#/components/schemas/jumpcloud.google_emm.DeviceInformation"
}
}
}
jumpcloud.google_emm.DeviceAndroidPolicy
{
"type": "object",
"properties": {
"policy": {
"type": "string"
}
}
}
jumpcloud.google_emm.DeviceData
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"deviceId": {
"type": "string",
"format": "byte"
}
}
}
jumpcloud.google_emm.DeviceInformation
{
"type": "object",
"properties": {
"memoryInfo": {
"$ref": "#/components/schemas/jumpcloud.google_emm.MemoryInfo"
},
"networkInfo": {
"$ref": "#/components/schemas/jumpcloud.google_emm.NetworkInfo"
},
"hardwareInfo": {
"$ref": "#/components/schemas/jumpcloud.google_emm.HardwareInfo"
},
"softwareInfo": {
"$ref": "#/components/schemas/jumpcloud.google_emm.SoftwareInfo"
},
"deviceStateInfo": {
"$ref": "#/components/schemas/jumpcloud.google_emm.DeviceStateInfo"
},
"emmEnrollmentInfo": {
"$ref": "#/components/schemas/jumpcloud.google_emm.EMMEnrollmentInfo"
}
}
}
jumpcloud.google_emm.DeviceSettings
{
"type": "object",
"properties": {
"adbEnabled": {
"type": "boolean"
},
"isEncrypted": {
"type": "boolean"
},
"isDeviceSecure": {
"type": "boolean"
},
"encryptionStatus": {
"type": "string"
},
"verifyAppsEnabled": {
"type": "boolean"
},
"unknownSourcesEnabled": {
"type": "boolean"
},
"developmentSettingsEnabled": {
"type": "boolean"
}
}
}
jumpcloud.google_emm.DeviceStateInfo
{
"type": "object",
"properties": {
"deviceState": {
"type": "string"
},
"deviceSettings": {
"$ref": "#/components/schemas/jumpcloud.google_emm.DeviceSettings"
},
"disabledReason": {
"type": "string"
},
"policyCompliant": {
"type": "boolean"
},
"securityPosture": {
"$ref": "#/components/schemas/jumpcloud.google_emm.SecurityPosture"
},
"appliedDeviceState": {
"type": "string"
},
"lastPolicySyncTime": {
"type": "string"
},
"lastStatusReportTime": {
"type": "string"
},
"commonCriteriaModeInfo": {
"$ref": "#/components/schemas/jumpcloud.google_emm.CommonCriteriaModeInfo"
}
}
}
jumpcloud.google_emm.EMMEnrollmentInfo
{
"type": "object",
"properties": {
"ownership": {
"type": "string"
},
"policyName": {
"type": "string"
},
"enrollmentTime": {
"type": "string"
},
"enrollmentType": {
"type": "string"
},
"managementMode": {
"type": "string"
},
"appliedPolicyName": {
"type": "string"
},
"appliedPolicyVersion": {
"type": "integer",
"format": "int64"
}
}
}
jumpcloud.google_emm.EnrollmentToken
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"metadata": {
"type": "string"
},
"createdBy": {
"type": "string"
},
"displayName": {
"type": "string"
},
"oneTimeOnly": {
"type": "boolean"
},
"qrCodeImage": {
"type": "string",
"format": "byte"
},
"createdWhere": {
"type": "string"
},
"enrollmentLink": {
"type": "string"
},
"enrollmentType": {
"type": "string"
},
"expirationTime": {
"type": "string"
}
}
}
jumpcloud.google_emm.EnrollmentType
{
"enum": [
"WORK_PROFILE",
"FULLY_MANAGED",
"DEDICATED",
"BYOD",
"COPE"
],
"type": "string",
"title": "Identifies how device enrolled",
"default": "WORK_PROFILE"
}
jumpcloud.google_emm.Enterprise
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"objectId": {
"type": "string",
"format": "byte"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"displayName": {
"type": "string"
},
"contactEmail": {
"type": "string",
"description": "not logging because it contains PII non-sensitive information."
},
"deviceGroupId": {
"type": "string",
"format": "byte"
},
"organizationObjectId": {
"type": "string",
"format": "byte"
},
"allowDeviceEnrollment": {
"type": "boolean"
}
}
}
jumpcloud.google_emm.Feature
{
"enum": [
"SOFTWARE_MANAGEMENT",
"ZERO_TOUCH_CUSTOMER_MANAGEMENT"
],
"type": "string",
"default": "SOFTWARE_MANAGEMENT"
}
jumpcloud.google_emm.HardwareInfo
{
"type": "object",
"properties": {
"brand": {
"type": "string"
},
"model": {
"type": "string"
},
"hardware": {
"type": "string"
},
"manufacturer": {
"type": "string"
},
"serialNumber": {
"type": "string"
},
"deviceBaseBandVersion": {
"type": "string"
}
}
}
jumpcloud.google_emm.ListDevicesResponse
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int64"
},
"devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jumpcloud.google_emm.DeviceData"
}
}
}
}
jumpcloud.google_emm.ListEnrollmentTokensResponse
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jumpcloud.google_emm.EnrollmentToken"
}
},
"totalCount": {
"type": "integer",
"format": "int64"
}
}
}
jumpcloud.google_emm.ListEnterprisesResponse
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int64"
},
"enterprises": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jumpcloud.google_emm.Enterprise"
}
}
}
}
jumpcloud.google_emm.MemoryInfo
{
"type": "object",
"properties": {
"totalRam": {
"type": "integer",
"format": "int64"
},
"totalInternalStorage": {
"type": "integer",
"format": "int64"
}
}
}
jumpcloud.google_emm.NetworkInfo
{
"type": "object",
"properties": {
"imei": {
"type": "string",
"description": "Not logging as it contains sensitive information."
},
"meid": {
"type": "string",
"description": "Not logging as it contains sensitive information."
},
"telephonyInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jumpcloud.google_emm.TelephonyInfo"
}
},
"wifiMacAddress": {
"type": "string",
"description": "Not logging as it contains sensitive information."
}
}
}
jumpcloud.google_emm.ProvisioningExtras
{
"type": "object",
"properties": {
"wifiSsid": {
"type": "string"
},
"wifiPassword": {
"type": "string"
},
"wifiSecurityType": {
"$ref": "#/components/schemas/jumpcloud.google_emm.WifiSecurityType"
},
"wifiHiddenNetwork": {
"type": "boolean"
}
}
}
jumpcloud.google_emm.SecurityPosture
{
"type": "object",
"properties": {
"devicePosture": {
"type": "string"
}
}
}
jumpcloud.google_emm.SignupURL
{
"type": "object",
"properties": {
"url": {
"type": "string",
"title": "not logging because it contains sensitive information"
},
"name": {
"type": "string",
"title": "not logging because it contains sensitive information"
}
}
}
jumpcloud.google_emm.SoftwareInfo
{
"type": "object",
"properties": {
"androidVersion": {
"type": "string"
},
"androidBuildTime": {
"type": "string"
},
"systemUpdateInfo": {
"$ref": "#/components/schemas/jumpcloud.google_emm.SystemUpdateInfo"
},
"bootloaderVersion": {
"type": "string"
},
"androidBuildNumber": {
"type": "string"
},
"securityPatchLevel": {
"type": "string"
},
"deviceKernelVersion": {
"type": "string"
},
"primaryLanguageCode": {
"type": "string"
},
"deviceBuildSignature": {
"type": "string"
},
"androidDevicePolicyVersionCode": {
"type": "integer",
"format": "int64"
}
}
}
jumpcloud.google_emm.SystemUpdateInfo
{
"type": "object",
"properties": {
"updateStatus": {
"type": "string"
},
"updateReceivedTime": {
"type": "string"
}
}
}
jumpcloud.google_emm.TelephonyInfo
{
"type": "object",
"properties": {
"carrierName": {
"type": "string",
"description": "Not logging as it contains sensitive information."
},
"phoneNumber": {
"type": "string",
"description": "Not logging as it contains sensitive information."
}
}
}
jumpcloud.google_emm.WebToken
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
jumpcloud.google_emm.WifiSecurityType
{
"enum": [
"NONE",
"WPA",
"WEP"
],
"type": "string",
"default": "NONE"
}
jumpcloud.ingresso.CreateAccessRequestsRequest
{
"type": "object",
"properties": {
"expiry": {
"type": "string",
"format": "date-time"
},
"remarks": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"operationId": {
"type": "string"
},
"requestorId": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"applicationIntId": {
"type": "string"
},
"additionalAttributes": {
"type": "object"
},
"organizationObjectId": {
"type": "string",
"format": "byte"
}
}
}
jumpcloud.ingresso.CreateAccessRequestsResponse
{
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
}
jumpcloud.ingresso.GetAccessRequestResponse
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"jobId": {
"type": "string",
"format": "byte"
},
"expiry": {
"type": "string"
},
"remarks": {
"type": "string"
},
"version": {
"type": "integer",
"format": "int32"
},
"accessId": {
"type": "string"
},
"duration": {
"type": "integer",
"format": "int32"
},
"metadata": {
"type": "string",
"format": "byte"
},
"companyId": {
"type": "string",
"format": "byte"
},
"createdBy": {
"type": "string"
},
"updatedBy": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"accessState": {
"type": "string"
},
"operationId": {
"type": "string"
},
"requestorId": {
"type": "string"
},
"tempGroupId": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"applicationIntId": {
"type": "string"
},
"onBehalfOfUserId": {
"type": "string"
},
"additionalAttributes": {
"type": "string",
"format": "byte"
}
}
}
jumpcloud.ingresso.RevokeAccessRequestsResponse
{
"type": "object"
}
jumpcloud.ingresso.UpdateAccessRequestsResponse
{
"type": "object"
}
jumpcloud.microsoft_mdm.DownloadConfigFilesRequest
{
"type": "object"
}
jumpcloud.msp.GetDetailsResponse
{
"type": "object",
"properties": {
"products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jumpcloud.msp.Product"
}
},
"hasContract": {
"type": "boolean"
},
"contractType": {
"type": "string"
},
"assignedLicenses": {
"type": "integer",
"format": "int64"
}
}
}
jumpcloud.msp.Product
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"capabilities": {
"type": "array",
"items": {
"type": "string"
}
},
"includedLicenses": {
"type": "integer",
"format": "int64"
},
"purchasedLicenses": {
"type": "integer",
"format": "int64"
}
}
}
jumpcloud.package_validator.ApplePackageDetails
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"assetUrl": {
"type": "string"
},
"subtitle": {
"type": "string"
},
"assetKind": {
"type": "string"
},
"packageKind": {
"type": "string"
},
"bundleVersion": {
"type": "string"
},
"assetSha256Size": {
"type": "integer",
"format": "int64"
},
"bundleIdentifier": {
"type": "string"
},
"assetSha256Strings": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
jumpcloud.package_validator.ValidateApplicationInstallPackageRequest
{
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
}
jumpcloud.package_validator.ValidateApplicationInstallPackageResponse
{
"type": "object",
"properties": {
"applePackageDetails": {
"$ref": "#/components/schemas/jumpcloud.package_validator.ApplePackageDetails"
}
}
}
ldap-server
{
"type": "object",
"title": "LDAP Server",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "Unique identifier of this LDAP server"
},
"name": {
"type": "string",
"description": "The name of this LDAP server"
},
"userLockoutAction": {
"enum": [
"disable",
"remove"
],
"type": "string",
"description": "action to take; one of 'remove' or 'disable'"
},
"userPasswordExpirationAction": {
"enum": [
"disable",
"remove"
],
"type": "string",
"description": "action to take; one of 'remove' or 'disable'"
}
}
}
mobileconfig
{
"type": "string",
"title": "mobileconfig"
}
o365.Domain
{
"type": "object",
"properties": {
"domain": {
"type": "string"
},
"default": {
"type": "boolean"
},
"objectId": {
"type": "string",
"format": "byte"
},
"resourceObjectId": {
"type": "string",
"format": "byte",
"description": "ObjectID of the Office 365 suite."
}
}
}
o365.DomainResponse
{
"type": "object",
"properties": {
"domain": {
"$ref": "#/components/schemas/o365.Domain"
}
}
}
o365.DomainsListResponse
{
"type": "object",
"properties": {
"domains": {
"type": "array",
"items": {
"$ref": "#/components/schemas/o365.Domain"
}
},
"totalCount": {
"type": "integer",
"format": "int64"
}
}
}
object-storage-item
{
"type": "object",
"title": "Object Storage item",
"properties": {
"objectId": {
"type": "string"
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/object-storage-version"
}
}
},
"description": "Object storage item information."
}
object-storage-version
{
"type": "object",
"title": "Object Storage Version",
"properties": {
"name": {
"type": "string"
},
"size": {
"type": "integer",
"default": 0
},
"status": {
"type": "string"
},
"version": {
"type": "integer",
"default": 0
},
"metadata": {
"type": "object"
},
"sha256sum": {
"type": "string"
},
"rejectedReason": {
"type": "string"
}
},
"description": "Object storage version information."
}
office365
{
"type": "object",
"title": "Office 365",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"defaultDomain": {
"$ref": "#/components/schemas/defaultDomain"
},
"groupsEnabled": {
"type": "boolean"
},
"userLockoutAction": {
"enum": [
"suspend",
"maintain"
],
"type": "string",
"readOnly": true
},
"userPasswordExpirationAction": {
"enum": [
"suspend",
"maintain"
],
"type": "string",
"readOnly": true
}
}
}
samba-domain
{
"type": "object",
"title": "Samba Domain",
"required": [
"name",
"sid"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "Unique identifier of this domain"
},
"sid": {
"type": "string",
"description": "Security identifier of this domain"
},
"name": {
"type": "string",
"description": "Name of this domain's WorkGroup"
}
}
}
scheduled-userstate-result
{
"type": "object",
"title": "Scheduled Userstate Result",
"properties": {
"state": {
"type": "string",
"description": "The state that the user will be in once the scheduled job executes."
},
"systemUserId": {
"type": "string",
"description": "The id of the user that the scheduled job will update."
},
"scheduledDate": {
"type": "string",
"description": "The UTC date and time when the scheduled job will execute."
},
"scheduledJobId": {
"type": "string",
"description": "The id of the scheduled job that scheduled the state change."
}
}
}
software-app
{
"type": "object",
"title": "Software Application Package",
"properties": {
"id": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/software-app-settings"
}
},
"displayName": {
"type": "string"
}
}
}
software-app-apple-vpp
{
"type": "object",
"title": "software-app-apple-vpp",
"properties": {
"details": {
"type": "object",
"description": "App details returned by iTunes API. See example. The properties in this field are out of our control and we cannot guarantee consistency, so it should be checked by the client and manage the details accordingly."
},
"totalLicenses": {
"type": "integer",
"default": 0
},
"isConfigEnabled": {
"type": "boolean",
"description": "Denotes if configuration has been enabled for the application. Returned only by ''GET /softwareapps/{id}''."
},
"appConfiguration": {
"type": "string",
"description": "Text sent to configure the application, the text should be a valid plist. Returned only by 'GET /softwareapps/{id}'."
},
"assignedLicenses": {
"type": "integer",
"default": 0
},
"availableLicenses": {
"type": "integer",
"default": 0
},
"supportedDeviceFamilies": {
"type": "array",
"items": {
"enum": [
"IPAD",
"IPHONE",
"IPOD",
"MAC"
],
"type": "string"
},
"description": "The supported device families for this VPP Application."
}
},
"description": "appleVpp is an optional attribute, it will only be present on apps with a 'setting' 'package_manager' type of 'APPLE_VPP'."
}
software-app-create
{
"type": "object",
"title": "SoftwareApplicationCreate",
"properties": {
"id": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/software-app-settings"
}
},
"uploadUrl": {
"type": "string"
},
"displayName": {
"type": "string"
}
}
}
software-app-google-android
{
"type": "object",
"title": "software-app-google-android",
"properties": {
"name": {
"type": "string",
"description": "The name of the app in the form enterprises/{enterprise}/applications/{packageName}."
},
"type": {
"enum": [
"APP_TYPE_UNSPECIFIED",
"PUBLIC",
"PRIVATE",
"WEBAPP"
],
"type": "string",
"description": "Type of this android application."
},
"author": {
"type": "string",
"description": "The name of the author of this app."
},
"iconUrl": {
"type": "string",
"description": "A link to an image that can be used as an icon for the app."
},
"category": {
"type": "string",
"description": "The app category (e.g. COMMUNICATION, SOCIAL, etc.)."
},
"startUrl": {
"type": "string",
"description": "The start URL, i.e. the URL that should load when the user opens the application. Applicable only for webapps."
},
"appPricing": {
"type": "string",
"description": "Whether this app is free, free with in-app purchases, or paid."
},
"appVersion": {
"type": "string",
"description": "Latest version currently available for this app."
},
"updateTime": {
"type": "string",
"description": "The approximate time (within 7 days) the app was last published."
},
"displayMode": {
"type": "string",
"description": "The display mode of the web app."
},
"installType": {
"enum": [
"AVAILABLE",
"FORCE_INSTALLED",
"BLOCKED"
],
"type": "string",
"description": "The type of installation to perform for an app."
},
"versionCode": {
"type": "integer",
"description": "The current version of the web app."
},
"contentRating": {
"type": "string",
"description": "The content rating for this app."
},
"minSdkVersion": {
"type": "integer",
"description": "The minimum Android SDK necessary to run the app."
},
"autoUpdateMode": {
"enum": [
"AUTO_UPDATE_DEFAULT",
"AUTO_UPDATE_POSTPONED",
"AUTO_UPDATE_HIGH_PRIORITY"
],
"type": "string",
"description": "Controls the auto-update mode for the app."
},
"androidFeatures": {
"type": "array",
"items": {
"type": "string"
},
"description": "The array of android features for the app."
},
"fullDescription": {
"type": "string",
"description": "Full app description, if available."
},
"permissionGrants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/software-app-permission-grants"
}
},
"managedProperties": {
"type": "boolean",
"description": "Indicates whether this app has managed properties or not."
},
"runtimePermission": {
"enum": [
"PROMPT",
"GRANT",
"DENY"
],
"type": "string",
"description": "The policy for granting permission requests to apps."
},
"distributionChannel": {
"type": "string",
"description": "How and to whom the package is made available."
},
"managedConfigurationTemplateId": {
"type": "string",
"description": "The managed configurations template for the app."
}
},
"description": "googleAndroid is an optional attribute, it will only be present on apps with a 'setting' 'package_manager' type of 'GOOGLE_ANDROID'."
}
software-app-microsoft-store
{
"type": "object",
"title": "software-app-microsoft-store",
"properties": {
"doNotUpdate": {
"type": "boolean",
"description": "Indicates whether the app can be updated or not."
},
"nonRemovable": {
"type": "boolean",
"description": "Indicates whether the app is removable by the users or not."
},
"packageFamilyName": {
"type": "string",
"description": "Package Family Name for the app from Microsoft App Store."
}
},
"description": "microsoftStore is an optional attribute, it will only be present on apps with a 'setting' 'package_manager' type of 'MICROSOFT_STORE'."
}
software-app-permission-grants
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "An opaque string uniquely identifying the Android permission, e.g. android.permission.READ_CALENDAR."
},
"policy": {
"enum": [
"PROMPT",
"GRANT",
"DENY"
],
"type": "string",
"description": "The policy for granting the permission."
}
}
}
software-app-reclaim-licenses
{
"type": "object",
"properties": {
"totalLicenses": {
"type": "integer",
"default": 0
},
"assignedLicenses": {
"type": "integer",
"default": 0
},
"availableLicenses": {
"type": "integer",
"default": 0
},
"reclaimedLicenses": {
"type": "integer",
"default": 0
}
}
}
software-app-settings
{
"type": "object",
"properties": {
"appleVpp": {
"$ref": "#/components/schemas/software-app-apple-vpp"
},
"location": {
"type": "string",
"description": "Repository where the app is located within the package manager"
},
"assetKind": {
"type": "string",
"description": "The manifest asset kind (ex: software)."
},
"packageId": {
"type": "string"
},
"autoUpdate": {
"type": "boolean",
"default": false
},
"description": {
"type": "string",
"description": "The software app description."
},
"packageKind": {
"type": "string",
"description": "The package manifest kind (ex: software-package)."
},
"desiredState": {
"type": "string",
"description": "State of Install or Uninstall"
},
"googleAndroid": {
"$ref": "#/components/schemas/software-app-google-android"
},
"storedPackage": {
"$ref": "#/components/schemas/object-storage-item"
},
"microsoftStore": {
"$ref": "#/components/schemas/software-app-microsoft-store"
},
"packageManager": {
"type": "string",
"description": "App store serving the app: APPLE_VPP, CHOCOLATEY, etc."
},
"packageVersion": {
"type": "string",
"description": "The package manifest version."
},
"assetSha256Size": {
"type": "integer",
"description": "The incremental size to use for summing the package as it is downloaded."
},
"packageSubtitle": {
"type": "string",
"description": "The package manifest subtitle."
},
"allowUpdateDelay": {
"type": "boolean",
"default": false
},
"locationObjectId": {
"type": "string",
"description": "ID of the repository where the app is located within the package manager"
},
"assetSha256Strings": {
"type": "array",
"items": {
"type": "string"
},
"description": "The array of checksums, one each for the hash size up to the total size of the package."
},
"enterpriseObjectId": {
"type": "string",
"description": "ID of the Enterprise with which this app is associated"
},
"commandLineArguments": {
"type": "string",
"description": "Command line arguments to use with the application."
},
"storedPackageObjectId": {
"type": "string",
"description": "ID of the stored package this app uses to reference the stored install media."
}
},
"x-examples": {
"example-1": {
"location": "string",
"packageId": "string",
"autoUpdate": false,
"desiredState": "string",
"packageManager": "string",
"allowUpdateDelay": false,
"locationObjectId": "string"
}
}
}
software-app-status
{
"title": "Software Application Status",
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "integer"
},
"state": {
"type": "string"
},
"details": {
"type": "string"
},
"version": {
"type": "string"
},
"systemId": {
"type": "string"
},
"timestamp": {
"type": "string"
},
"softwareAppId": {
"type": "string"
}
}
}
software-app-with-status
{
"title": "SoftwareAppsWithStatus",
"properties": {
"app": {
"$ref": "#/components/schemas/software-app"
},
"status": {
"$ref": "#/components/schemas/software-app-status"
}
}
}
subscription
{
"type": "object",
"title": "Subscription",
"required": [
"annualPrice",
"displayName",
"features",
"listPrice",
"productCode"
],
"properties": {
"features": {
"type": "array",
"items": {
"$ref": "#/components/schemas/feature"
},
"description": "Array of the features included in the subscription."
},
"listPrice": {
"type": "number",
"description": "The list price of this subscription."
},
"annualPrice": {
"type": "number",
"description": "The annual (discounted) price of this subscription."
},
"displayName": {
"type": "string",
"description": "The display name of this subscription."
},
"productCode": {
"type": "string",
"description": "Unique identifier corresponding to this subscription."
}
}
}
system-insights-alf
{
"type": "object",
"title": "System Insights ALF",
"properties": {
"version": {
"type": "string"
},
"system_id": {
"type": "string"
},
"global_state": {
"type": "integer"
},
"logging_option": {
"type": "integer"
},
"collection_time": {
"type": "string"
},
"firewall_unload": {
"type": "integer"
},
"logging_enabled": {
"type": "integer"
},
"stealth_enabled": {
"type": "integer"
},
"allow_signed_enabled": {
"type": "integer"
}
}
}
system-insights-alf-exceptions
{
"type": "object",
"title": "System Insights ALF Exceptions",
"properties": {
"path": {
"type": "string"
},
"state": {
"type": "number"
},
"system_id": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-alf-explicit-auths
{
"type": "object",
"title": "System Insights ALF Explicit Authorizations",
"properties": {
"process": {
"type": "string"
},
"system_id": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-appcompat-shims
{
"type": "object",
"title": "System Insights Application Compatibility Shims",
"properties": {
"path": {
"type": "string"
},
"type": {
"type": "string"
},
"sdb_id": {
"type": "string"
},
"system_id": {
"type": "string"
},
"executable": {
"type": "string"
},
"description": {
"type": "string"
},
"install_time": {
"type": "number"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-apps
{
"type": "object",
"title": "System Insights Apps",
"example": {
"name": "App Store.app",
"path": "/Applications/App Store.app",
"element": "",
"category": "public.app-category.utilities",
"compiler": "com.apple.compilers.llvm.clang.1_0",
"copyright": "",
"system_id": "5c9e51a13c5146f89bae12d9",
"bundle_name": "App Store",
"environment": "",
"info_string": "",
"display_name": "App Store",
"bundle_version": "658.1",
"collection_time": "2019-06-03T19:41:30.658Z",
"last_opened_time": 1556688963.50383,
"bundle_executable": "App Store",
"bundle_identifier": "com.apple.appstore",
"development_region": "English",
"applescript_enabled": "1",
"bundle_package_type": "APPL",
"bundle_short_version": "2.4",
"minimum_system_version": "10.13"
},
"properties": {
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"element": {
"type": "string"
},
"category": {
"type": "string"
},
"compiler": {
"type": "string"
},
"copyright": {
"type": "string"
},
"system_id": {
"type": "string"
},
"bundle_name": {
"type": "string"
},
"environment": {
"type": "string"
},
"info_string": {
"type": "string"
},
"display_name": {
"type": "string"
},
"bundle_version": {
"type": "string"
},
"collection_time": {
"type": "string"
},
"last_opened_time": {
"type": "number"
},
"bundle_executable": {
"type": "string"
},
"bundle_identifier": {
"type": "string"
},
"development_region": {
"type": "string"
},
"applescript_enabled": {
"type": "string"
},
"bundle_package_type": {
"type": "string"
},
"bundle_short_version": {
"type": "string"
},
"minimum_system_version": {
"type": "string"
}
}
}
system-insights-authorized-keys
{
"type": "object",
"title": "System Insights Authorized Keys",
"properties": {
"key": {
"type": "string"
},
"uid": {
"type": "string"
},
"key_file": {
"type": "string"
},
"algorithm": {
"type": "string"
},
"system_id": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-azure-instance-metadata
{
"type": "object",
"title": "System Insights Azure Instance Metadata",
"properties": {
"sku": {
"type": "string"
},
"name": {
"type": "string"
},
"zone": {
"type": "string"
},
"offer": {
"type": "string"
},
"vm_id": {
"type": "string"
},
"os_type": {
"type": "string"
},
"version": {
"type": "string"
},
"vm_size": {
"type": "string"
},
"location": {
"type": "string"
},
"publisher": {
"type": "string"
},
"system_id": {
"type": "string"
},
"collection_time": {
"type": "string"
},
"subscription_id": {
"type": "string"
},
"vm_scale_set_name": {
"type": "string"
},
"placement_group_id": {
"type": "string"
},
"resource_group_name": {
"type": "string"
},
"platform_fault_domain": {
"type": "string"
},
"platform_update_domain": {
"type": "string"
}
}
}
system-insights-azure-instance-tags
{
"type": "object",
"title": "System Insights Azure Instance Tags",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
},
"vm_id": {
"type": "string"
},
"system_id": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-battery
{
"type": "object",
"title": "System Insights Battery",
"example": {
"model": "cupidatat quis esse tempor nostr",
"state": "Duis qui eu labore",
"health": "ipsum Duis amet magna sint",
"charged": 63086136,
"voltage": -79728034,
"amperage": 93836453,
"charging": 6577424,
"condition": "magna Ut dolor laborum",
"system_id": "elit nulla cillum et",
"cycle_count": -58203101,
"manufacturer": "laboris",
"max_capacity": 407375,
"serial_number": "est do nisi anim eu",
"collection_time": "anim in dolor",
"current_capacity": 95829126,
"manufacture_date": 66625366,
"designed_capacity": 51607498,
"percent_remaining": -77798506,
"minutes_until_empty": 56660087,
"minutes_to_full_charge": -43087634
},
"properties": {
"model": {
"type": "string"
},
"state": {
"type": "string"
},
"health": {
"type": "string"
},
"charged": {
"type": "integer"
},
"voltage": {
"type": "integer"
},
"amperage": {
"type": "integer"
},
"charging": {
"type": "integer"
},
"condition": {
"type": "string"
},
"system_id": {
"type": "string"
},
"cycle_count": {
"type": "integer"
},
"manufacturer": {
"type": "string"
},
"max_capacity": {
"type": "integer"
},
"serial_number": {
"type": "string"
},
"collection_time": {
"type": "string"
},
"current_capacity": {
"type": "integer"
},
"manufacture_date": {
"type": "integer"
},
"designed_capacity": {
"type": "integer"
},
"percent_remaining": {
"type": "integer"
},
"minutes_until_empty": {
"type": "integer"
},
"minutes_to_full_charge": {
"type": "integer"
}
}
}
system-insights-bitlocker-info
{
"type": "object",
"title": "System Insights Bitlocker Info",
"example": {
"devide_id": "\\\\\\\\?\\\\Volume{3ba5cc52-e0fd-45fa-b8b8-5c88f44f8b17}\\",
"system_id": "5c9e51a13c5146f89bae12d9",
"drive_letter": "C:",
"collection_time": "2019-06-03T19:41:30.658Z",
"conversion_status": 0,
"encryption_method": "None",
"protection_status": 0,
"persistent_volume_id": ""
},
"properties": {
"device_id": {
"type": "string"
},
"system_id": {
"type": "string"
},
"drive_letter": {
"type": "string"
},
"collection_time": {
"type": "string"
},
"conversion_status": {
"type": "integer"
},
"encryption_method": {
"type": "string"
},
"protection_status": {
"type": "integer"
},
"persistent_volume_id": {
"type": "string"
}
}
}
system-insights-browser-plugins
{
"type": "object",
"title": "System Insights Browser Plugins",
"example": {
"sdk": "7D175",
"uid": "0",
"name": "LastPass",
"path": "/Library/Internet Plug-Ins/nplastpass.plugin/",
"native": 0,
"version": "4.1.7",
"disabled": 0,
"system_id": "5c9e51a13c5146f89bae12d9",
"identifier": "com.lastpass.nplastpass",
"description": "LastPass Plugin",
"collection_time": "2019-06-03T19:41:30.858Z",
"development_region": "en-US"
},
"properties": {
"sdk": {
"type": "string"
},
"uid": {
"type": "string"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"native": {
"type": "integer"
},
"version": {
"type": "string"
},
"disabled": {
"type": "integer"
},
"system_id": {
"type": "string"
},
"identifier": {
"type": "string"
},
"description": {
"type": "string"
},
"collection_time": {
"type": "string"
},
"development_region": {
"type": "string"
}
}
}
system-insights-certificates
{
"properties": {
"ca": {
"type": "integer"
},
"sid": {
"type": "string"
},
"path": {
"type": "string"
},
"sha1": {
"type": "string"
},
"store": {
"type": "string"
},
"issuer": {
"type": "string"
},
"serial": {
"type": "string"
},
"subject": {
"type": "string"
},
"store_id": {
"type": "string"
},
"username": {
"type": "string"
},
"key_usage": {
"type": "string"
},
"system_id": {
"type": "string"
},
"common_name": {
"type": "string"
},
"self_signed": {
"type": "integer"
},
"key_strength": {
"type": "string"
},
"key_algorithm": {
"type": "string"
},
"store_location": {
"type": "string"
},
"subject_key_id": {
"type": "string"
},
"not_valid_after": {
"type": "string"
},
"authority_key_id": {
"type": "string"
},
"not_valid_before": {
"type": "string"
},
"signing_algorithm": {
"type": "string"
}
}
}
system-insights-chassis-info
{
"type": "object",
"title": "System Insights Chassis Info",
"properties": {
"sku": {
"type": "string"
},
"lock": {
"type": "string"
},
"model": {
"type": "string"
},
"serial": {
"type": "string"
},
"status": {
"type": "string"
},
"system_id": {
"type": "string"
},
"smbios_tag": {
"type": "string"
},
"description": {
"type": "string"
},
"manufacturer": {
"type": "string"
},
"audible_alarm": {
"type": "string"
},
"chassis_types": {
"type": "string"
},
"visible_alarm": {
"type": "string"
},
"collection_time": {
"type": "string"
},
"security_breach": {
"type": "string"
},
"breach_description": {
"type": "string"
}
}
}
system-insights-chrome-extensions
{
"type": "object",
"title": "System Insights Chrome Extensions",
"example": {
"uid": "501",
"name": "chrome media router",
"path": "/users/thomas/library/application support/google/chrome/default/extensions/pkedcjkdefgpdelpbcmbmeomcjbeemfm/7419.311.0.1_0/",
"author": "",
"locale": "en",
"version": "7419.311.0.1",
"system_id": "5c9e51a13c5146f89bae12d9",
"identifier": "pkedcjkdefgpdelpbcmbmeomcjbeemfm",
"persistent": 0,
"update_url": "https://clients2.google.com/service/update2/crx",
"description": "provider for discovery and services for mirroring of chrome media router",
"permissions": "alarms, cast, cast.streaming, declarativewebrequest, desktopcapture, gcm, http://*/*, identity, identity.email, management, mdns, mediarouterprivate, metricsprivate, networkingprivate, processes, storage, system.cpu, settingsprivate, tabcapture, tabs, webview, https://hangouts.google.com/*, https://*.google.com/cast/chromecast/home/gsse",
"collection_time": "2019-06-03t19:41:31.125z"
},
"properties": {
"uid": {
"type": "string"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"author": {
"type": "string"
},
"locale": {
"type": "string"
},
"version": {
"type": "string"
},
"system_id": {
"type": "string"
},
"identifier": {
"type": "string"
},
"persistent": {
"type": "integer"
},
"update_url": {
"type": "string"
},
"description": {
"type": "string"
},
"permissions": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-connectivity
{
"type": "object",
"title": "system insights connectivity",
"properties": {
"system_id": {
"type": "string"
},
"ipv4_subnet": {
"type": "integer"
},
"ipv6_subnet": {
"type": "integer"
},
"disconnected": {
"type": "integer"
},
"ipv4_internet": {
"type": "integer"
},
"ipv6_internet": {
"type": "integer"
},
"collection_time": {
"type": "string"
},
"ipv4_no_traffic": {
"type": "integer"
},
"ipv6_no_traffic": {
"type": "integer"
},
"ipv4_local_network": {
"type": "integer"
},
"ipv6_local_network": {
"type": "integer"
}
}
}
system-insights-crashes
{
"type": "object",
"title": "System Insights Crashes",
"properties": {
"pid": {
"type": "string"
},
"uid": {
"type": "integer"
},
"path": {
"type": "string"
},
"type": {
"type": "string"
},
"parent": {
"type": "string"
},
"version": {
"type": "string"
},
"datetime": {
"type": "string"
},
"registers": {
"type": "string"
},
"system_id": {
"type": "string"
},
"crash_path": {
"type": "string"
},
"identifier": {
"type": "string"
},
"responsible": {
"type": "string"
},
"stack_trace": {
"type": "string"
},
"crashed_thread": {
"type": "string"
},
"exception_type": {
"type": "string"
},
"collection_time": {
"type": "string"
},
"exception_codes": {
"type": "string"
},
"exception_notes": {
"type": "string"
}
}
}
system-insights-cups-destinations
{
"properties": {
"name": {
"type": "string"
},
"system_id": {
"type": "string"
},
"option_name": {
"type": "string"
},
"option_value": {
"type": "string"
}
}
}
system-insights-disk-encryption
{
"type": "object",
"title": "System Insights Disk Encryption",
"example": {
"uid": "",
"name": "/dev/disk8",
"type": "",
"uuid": "",
"encrypted": 0,
"system_id": "5c9e51a13c5146f89bae12d9",
"user_uuid": "",
"collection_time": "2019-06-03T19:41:31.557Z",
"encryption_status": "undefined"
},
"properties": {
"uid": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"uuid": {
"type": "string"
},
"encrypted": {
"type": "integer"
},
"system_id": {
"type": "string"
},
"user_uuid": {
"type": "string"
},
"collection_time": {
"type": "string"
},
"encryption_status": {
"type": "string"
}
}
}
system-insights-disk-info
{
"type": "object",
"title": "System Insights Disk Info",
"example": {
"id": "\\\\.\\PHYSICALDRIVE0",
"name": "\\\\.\\PHYSICALDRIVE0",
"type": "SCSI",
"serial": "",
"disk_size": "64420392960",
"system_id": "5c9e51a13c5146f89bae12d9",
"disk_index": 0,
"partitions": 3,
"description": "Disk drive",
"manufacturer": "(Standard disk drives)",
"pnp_device_id": "SCSI\\DISK&VEN_VMWARE_&PROD_VMWARE_VIRTUAL_S\\5&1EC51BF7&0&000000",
"hardware_model": "VMware, VMware Virtual S SCSI Disk Device",
"collection_time": "2019-06-03T19:41:30.658Z"
},
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"serial": {
"type": "string"
},
"disk_size": {
"type": "string"
},
"system_id": {
"type": "string"
},
"disk_index": {
"type": "integer"
},
"partitions": {
"type": "integer"
},
"description": {
"type": "string"
},
"manufacturer": {
"type": "string"
},
"pnp_device_id": {
"type": "string"
},
"hardware_model": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-dns-resolvers
{
"type": "object",
"title": "System Insights DNS Resolvers",
"properties": {
"id": {
"type": "number"
},
"type": {
"type": "string"
},
"address": {
"type": "string"
},
"netmask": {
"type": "string"
},
"options": {
"type": "string"
},
"system_id": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-etc-hosts
{
"type": "object",
"title": "System Insights Etc Hosts",
"example": {
"address": "192.168.2.21",
"hostnames": "hosty hosty.local",
"system_id": "5c9e51a13c5146f89bae12d9",
"collection_time": "2019-06-03T19:41:30.658Z"
},
"properties": {
"address": {
"type": "string"
},
"hostnames": {
"type": "string"
},
"system_id": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-firefox-addons
{
"type": "object",
"title": "System Insights Firefox Addons",
"example": {
"uid": "501",
"name": "Firefox Monitor",
"path": "",
"type": "extension",
"active": 1,
"creator": "null",
"version": "2.8",
"visible": 1,
"disabled": 0,
"location": "app-system-addons",
"system_id": "5c9e51a13c5146f89bae12d9",
"autoupdate": 1,
"identifier": "fxmonitor@mozilla.org",
"source_url": "file:///var/folders/dn/zjm_0lzn4lv6bgnt5b3nkgxh0000gn/T/tmpaddon-9fb449",
"description": "",
"collection_time": "2019-06-03T19:41:31.204Z"
},
"properties": {
"uid": {
"type": "string"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"type": {
"type": "string"
},
"active": {
"type": "integer"
},
"creator": {
"type": "string"
},
"version": {
"type": "string"
},
"visible": {
"type": "integer"
},
"disabled": {
"type": "integer"
},
"location": {
"type": "string"
},
"system_id": {
"type": "string"
},
"autoupdate": {
"type": "integer"
},
"identifier": {
"type": "string"
},
"source_url": {
"type": "string"
},
"description": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-groups
{
"type": "object",
"title": "System Insights Groups",
"example": {
"gid": "701",
"comment": "",
"group_sid": "",
"groupname": "1",
"system_id": "5c9e51a13c5146f89bae12d9",
"gid_signed": "701",
"collection_time": "2019-06-03T19:41:31.673Z"
},
"properties": {
"gid": {
"type": "string"
},
"comment": {
"type": "string"
},
"group_sid": {
"type": "string"
},
"groupname": {
"type": "string"
},
"system_id": {
"type": "string"
},
"gid_signed": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-ie-extensions
{
"type": "object",
"title": "System Insights IE Extensions",
"properties": {
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"version": {
"type": "string"
},
"system_id": {
"type": "string"
},
"registry_path": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-interface-addresses
{
"type": "object",
"title": "System Insights Interface Addresses",
"example": {
"mask": "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff",
"type": "unknown",
"address": "::1",
"broadcast": "",
"interface": "lo0",
"system_id": "5c9e51a13c5146f89bae12d9",
"friendly_name": "",
"point_to_point": "::1",
"collection_time": "2019-06-03T19:41:31.008Z"
},
"properties": {
"mask": {
"type": "string"
},
"type": {
"type": "string"
},
"address": {
"type": "string"
},
"broadcast": {
"type": "string"
},
"interface": {
"type": "string"
},
"system_id": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"point_to_point": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-interface-details
{
"type": "object",
"properties": {
"mac": {
"type": "string"
},
"mtu": {
"type": "integer"
},
"type": {
"type": "integer"
},
"flags": {
"type": "integer"
},
"speed": {
"type": "integer"
},
"ibytes": {
"type": "string"
},
"idrops": {
"type": "string"
},
"metric": {
"type": "integer"
},
"obytes": {
"type": "string"
},
"odrops": {
"type": "string"
},
"enabled": {
"type": "integer"
},
"ierrors": {
"type": "string"
},
"oerrors": {
"type": "string"
},
"service": {
"type": "string"
},
"ipackets": {
"type": "string"
},
"opackets": {
"type": "string"
},
"pci_slot": {
"type": "string"
},
"interface": {
"type": "string"
},
"system_id": {
"type": "string"
},
"collisions": {
"type": "string"
},
"dns_domain": {
"type": "string"
},
"link_speed": {
"type": "string"
},
"description": {
"type": "string"
},
"dhcp_server": {
"type": "string"
},
"last_change": {
"type": "string"
},
"dhcp_enabled": {
"type": "integer"
},
"manufacturer": {
"type": "string"
},
"connection_id": {
"type": "string"
},
"dns_host_name": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"physical_adapter": {
"type": "integer"
},
"connection_status": {
"type": "string"
},
"dhcp_lease_expires": {
"type": "string"
},
"dhcp_lease_obtained": {
"type": "string"
},
"dns_server_search_order": {
"type": "string"
},
"dns_domain_suffix_search_order": {
"type": "string"
}
}
}
system-insights-kernel-info
{
"type": "object",
"title": "System Insights Kernel Info",
"properties": {
"path": {
"type": "string"
},
"device": {
"type": "string"
},
"version": {
"type": "string"
},
"arguments": {
"type": "string"
},
"system_id": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-launchd
{
"type": "object",
"title": "System Insights LaunchD",
"properties": {
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"label": {
"type": "string"
},
"program": {
"type": "string"
},
"disabled": {
"type": "string"
},
"username": {
"type": "string"
},
"groupname": {
"type": "string"
},
"on_demand": {
"type": "string"
},
"system_id": {
"type": "string"
},
"keep_alive": {
"type": "string"
},
"run_at_load": {
"type": "string"
},
"stderr_path": {
"type": "string"
},
"stdout_path": {
"type": "string"
},
"watch_paths": {
"type": "string"
},
"process_type": {
"type": "string"
},
"root_directory": {
"type": "string"
},
"start_interval": {
"type": "string"
},
"start_on_mount": {
"type": "string"
},
"collection_time": {
"type": "string"
},
"program_arguments": {
"type": "string"
},
"queue_directories": {
"type": "string"
},
"working_directory": {
"type": "string"
},
"inetd_compatibility": {
"type": "string"
}
}
}
system-insights-linux-packages
{
"type": "object",
"title": "System Insights Linux Packages",
"example": {
"arch": "amd64",
"name": "zip",
"size": "100000",
"version": "3.0-11build1",
"system_id": "5c9e51a13c5146f89bae12d9",
"install_time": 100000,
"package_format": "deb",
"mount_namespace_id": "id123",
"pid_with_namespace": 0,
"release_or_revision": "11build1",
"maintainer_or_vendor": "Ubuntu Developers <ubuntu-devel-discuss@lists.ubuntu.com>",
"package_group_or_section": "utils"
},
"properties": {
"arch": {
"type": "string"
},
"name": {
"type": "string"
},
"size": {
"type": "string"
},
"version": {
"type": "string"
},
"system_id": {
"type": "string"
},
"install_time": {
"type": "integer"
},
"package_format": {
"type": "string"
},
"mount_namespace_id": {
"type": "string"
},
"pid_with_namespace": {
"type": "integer"
},
"release_or_revision": {
"type": "string"
},
"maintainer_or_vendor": {
"type": "string"
},
"package_group_or_section": {
"type": "string"
}
}
}
system-insights-logged-in-users
{
"type": "object",
"title": "System Insights Logged-In Users",
"properties": {
"pid": {
"type": "integer"
},
"tty": {
"type": "string"
},
"host": {
"type": "string"
},
"time": {
"type": "integer"
},
"type": {
"type": "string"
},
"user": {
"type": "string"
},
"system_id": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-logical-drives
{
"type": "object",
"title": "System Insights Logical Drives",
"example": {
"size": "63778582528",
"type": "Unknown",
"device_id": "C:",
"system_id": "5c9e51a13c5146f89bae12d9",
"free_space": "43194331136",
"file_system": "NTFS",
"boot_partition": 0,
"collection_time": "2019-06-03T19:41:30.658Z"
},
"properties": {
"size": {
"type": "string"
},
"type": {
"type": "string"
},
"device_id": {
"type": "string"
},
"system_id": {
"type": "string"
},
"free_space": {
"type": "string"
},
"file_system": {
"type": "string"
},
"boot_partition": {
"type": "integer"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-managed-policies
{
"type": "object",
"title": "System Insights Managed Policies",
"properties": {
"name": {
"type": "string"
},
"uuid": {
"type": "string"
},
"value": {
"type": "string"
},
"domain": {
"type": "string"
},
"manual": {
"type": "integer"
},
"username": {
"type": "string"
},
"system_id": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-mounts
{
"type": "object",
"title": "System Insights Mounts",
"example": {
"path": "/private/var/folders/zz/zyxvpxvq6csfxvn_n0000000000000/T/.vbfolder_1dQavK",
"type": "hfs",
"flags": "70292505",
"blocks": "388086",
"device": "/dev/disk5s1",
"inodes": "4294967279",
"system_id": "5c9e51a13c5146f89bae12d9",
"blocks_free": "95135",
"blocks_size": "4096",
"inodes_free": "4294966853",
"device_alias": "/dev/disk5s1",
"collection_time": "2019-06-03T19:41:31.746Z",
"blocks_available": "95135"
},
"properties": {
"path": {
"type": "string"
},
"type": {
"type": "string"
},
"flags": {
"type": "string"
},
"blocks": {
"type": "string"
},
"device": {
"type": "string"
},
"inodes": {
"type": "string"
},
"system_id": {
"type": "string"
},
"blocks_free": {
"type": "string"
},
"blocks_size": {
"type": "string"
},
"inodes_free": {
"type": "string"
},
"device_alias": {
"type": "string"
},
"collection_time": {
"type": "string"
},
"blocks_available": {
"type": "string"
}
}
}
system-insights-os-version
{
"type": "object",
"title": "System Insights OS Version",
"example": {
"name": "Mac OS X",
"build": "17G65",
"major": 10,
"minor": 13,
"patch": 6,
"version": "10.13.6",
"codename": "",
"platform": "darwin",
"system_id": "5c9e51a13c5146f89bae12d9",
"install_date": "",
"platform_like": "darwin",
"collection_time": "2019-06-03T19:41:30.933Z"
},
"properties": {
"name": {
"type": "string"
},
"build": {
"type": "string"
},
"major": {
"type": "integer"
},
"minor": {
"type": "integer"
},
"patch": {
"type": "integer"
},
"version": {
"type": "string"
},
"codename": {
"type": "string"
},
"platform": {
"type": "string"
},
"system_id": {
"type": "string"
},
"install_date": {
"type": "string"
},
"platform_like": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-patches
{
"type": "object",
"title": "System Insights Patches",
"example": {
"csname": "DESKTOP-B17DUKP",
"caption": "http://support.microsoft.com/?kbid=4503308",
"hotfix_id": "KB4503308",
"system_id": "5c9e51a13c5146f89bae12d9",
"description": "Security Update",
"fix_comments": "",
"install_date": "",
"installed_by": "NT AUTHORITY\\SYSTEM",
"installed_on": "7/30/2019",
"collection_time": "2019-06-03T19:41:31.673Z"
},
"properties": {
"csname": {
"type": "string"
},
"caption": {
"type": "string"
},
"hotfix_id": {
"type": "string"
},
"system_id": {
"type": "string"
},
"description": {
"type": "string"
},
"fix_comments": {
"type": "string"
},
"install_date": {
"type": "string"
},
"installed_by": {
"type": "string"
},
"installed_on": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-programs
{
"type": "object",
"title": "System Insights Programs",
"example": {
"name": "Update for Windows 10 for x64-based Systems (KB4480730)",
"version": "2.51.0.0",
"language": "0",
"publisher": "Microsoft Corporation",
"system_id": "5c9e51a13c5146f89bae12d9",
"install_date": "20190724",
"install_source": "C:\\Windows\\SoftwareDistribution\\Download\\b78f29c88063bd09e7afd48e257d0126\\img\\",
"collection_time": "2019-06-03T19:41:31.673Z",
"install_location": "",
"uninstall_string": "MsiExec.exe /X{2E8B8BDD-03DF-4C1C-8C99-E6A4BCBF43CE}",
"identifying_number": "{2E8B8BDD-03DF-4C1C-8C99-E6A4BCBF43CE}"
},
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"language": {
"type": "string"
},
"publisher": {
"type": "string"
},
"system_id": {
"type": "string"
},
"install_date": {
"type": "string"
},
"install_source": {
"type": "string"
},
"collection_time": {
"type": "string"
},
"install_location": {
"type": "string"
},
"uninstall_string": {
"type": "string"
},
"identifying_number": {
"type": "string"
}
}
}
system-insights-python-packages
{
"properties": {
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"auther": {
"type": "string"
},
"license": {
"type": "string"
},
"summary": {
"type": "string"
},
"version": {
"type": "string"
},
"directory": {
"type": "string"
},
"system_id": {
"type": "string"
}
}
}
system-insights-safari-extensions
{
"type": "object",
"title": "System Insights Safari Extensions",
"example": {
"sdk": "6.0",
"uid": "501",
"name": "Adblock Plus",
"path": "/Users/samuelharvanek/Library/Safari/Extensions/Adblock Plus.safariextz",
"author": "Eyeo GmbH",
"version": "1.12.5",
"system_id": "5cdb13e85a0e0719283583c0",
"identifier": "org.adblockplus.adblockplussafari",
"update_url": "https://update.adblockplus.org/adblockplussafari/updates.plist",
"description": "Used by over 50 million people, a free ad blocker that blocks ALL annoying ads, malware and tracking.",
"developer_id": "GRYYZR985A",
"collection_time": "2019-05-16T18:58:15.673Z"
},
"properties": {
"sdk": {
"type": "string"
},
"uid": {
"type": "string"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"author": {
"type": "string"
},
"version": {
"type": "string"
},
"system_id": {
"type": "string"
},
"identifier": {
"type": "string"
},
"update_url": {
"type": "string"
},
"description": {
"type": "string"
},
"developer_id": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-scheduled-tasks
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"state": {
"type": "string"
},
"action": {
"type": "string"
},
"hidden": {
"type": "integer"
},
"enabled": {
"type": "integer"
},
"system_id": {
"type": "string"
},
"last_run_code": {
"type": "string"
},
"last_run_time": {
"type": "string"
},
"next_run_time": {
"type": "string"
},
"last_run_message": {
"type": "string"
}
}
}
system-insights-secureboot
{
"type": "object",
"title": "System Insights Secure Boot",
"properties": {
"system_id": {
"type": "string"
},
"setup_mode": {
"type": "number"
},
"secure_boot": {
"type": "number"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-services
{
"type": "object",
"properties": {
"pid": {
"type": "integer"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"status": {
"type": "string"
},
"system_id": {
"type": "string"
},
"start_type": {
"type": "string"
},
"description": {
"type": "string"
},
"module_path": {
"type": "string"
},
"display_name": {
"type": "string"
},
"service_type": {
"type": "string"
},
"user_account": {
"type": "string"
},
"win32_exit_code": {
"type": "integer"
},
"service_exit_code": {
"type": "integer"
}
}
}
system-insights-shadow
{
"type": "object",
"title": "System Insights Shadow",
"properties": {
"max": {
"type": "string"
},
"min": {
"type": "string"
},
"flag": {
"type": "string"
},
"expire": {
"type": "string"
},
"warning": {
"type": "string"
},
"hash_alg": {
"type": "string"
},
"inactive": {
"type": "string"
},
"username": {
"type": "string"
},
"system_id": {
"type": "string"
},
"last_change": {
"type": "string"
},
"collection_time": {
"type": "string"
},
"password_status": {
"type": "string"
}
}
}
system-insights-shared-folders
{
"type": "object",
"title": "System Insights Shared Folders",
"properties": {
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"system_id": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-shared-resources
{
"type": "object",
"title": "System Insights Shared Resources",
"properties": {
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"type": {
"type": "string"
},
"status": {
"type": "string"
},
"system_id": {
"type": "string"
},
"description": {
"type": "string"
},
"install_date": {
"type": "string"
},
"allow_maximum": {
"type": "integer"
},
"collection_time": {
"type": "string"
},
"maximum_allowed": {
"type": "string"
}
}
}
system-insights-sharing-preferences
{
"type": "object",
"title": "System Insights Sharing Preferences",
"properties": {
"system_id": {
"type": "string"
},
"disc_sharing": {
"type": "integer"
},
"file_sharing": {
"type": "integer"
},
"remote_login": {
"type": "integer"
},
"screen_sharing": {
"type": "integer"
},
"collection_time": {
"type": "string"
},
"content_caching": {
"type": "integer"
},
"printer_sharing": {
"type": "integer"
},
"internet_sharing": {
"type": "integer"
},
"bluetooth_sharing": {
"type": "integer"
},
"remote_management": {
"type": "integer"
},
"remote_apple_events": {
"type": "integer"
}
}
}
system-insights-sip-config
{
"type": "object",
"title": "System Insights SIP Config",
"properties": {
"enabled": {
"type": "integer"
},
"system_id": {
"type": "string"
},
"config_flag": {
"type": "string"
},
"enabled_nvram": {
"type": "integer"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-startup-items
{
"properties": {
"args": {
"type": "string"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"status": {
"type": "string"
},
"username": {
"type": "string"
},
"system_id": {
"type": "string"
}
}
}
system-insights-system-controls
{
"type": "object",
"title": "System Insights System Controls",
"properties": {
"oid": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"subsystem": {
"type": "string"
},
"system_id": {
"type": "string"
},
"field_name": {
"type": "string"
},
"config_value": {
"type": "string"
},
"current_value": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-system-info
{
"type": "object",
"title": "System Insights System Info",
"example": {
"uuid": "11111111-FFFF-1111-FFFF-111111111111",
"cpu_type": "x86_64h",
"hostname": "johnnys-macbook-pro-2.local",
"cpu_brand": "Intel(R) Core(TM) i7-7820HQ CPU @ 2.90GHz",
"system_id": "5c9e51a13c5146f89bae12d9",
"cpu_subtype": "Intel x86-64h Haswell",
"computer_name": "Johnny's MacBook Pro (2)",
"cpu_microcode": "",
"hardware_model": "MacBookPro14,3 ",
"local_hostname": "Jonnys-MacBook-Pro-2",
"collection_time": "2019-06-03T19:41:30.771Z",
"hardware_serial": "111111FFFFFF",
"hardware_vendor": "Apple Inc. ",
"physical_memory": "17179869184",
"hardware_version": "1.0 ",
"cpu_logical_cores": 8,
"cpu_physical_cores": 4
},
"properties": {
"uuid": {
"type": "string"
},
"cpu_type": {
"type": "string"
},
"hostname": {
"type": "string"
},
"cpu_brand": {
"type": "string"
},
"system_id": {
"type": "string"
},
"cpu_subtype": {
"type": "string"
},
"computer_name": {
"type": "string"
},
"cpu_microcode": {
"type": "string"
},
"hardware_model": {
"type": "string"
},
"local_hostname": {
"type": "string"
},
"collection_time": {
"type": "string"
},
"hardware_serial": {
"type": "string"
},
"hardware_vendor": {
"type": "string"
},
"physical_memory": {
"type": "string"
},
"hardware_version": {
"type": "string"
},
"cpu_logical_cores": {
"type": "integer"
},
"cpu_physical_cores": {
"type": "integer"
}
}
}
system-insights-tpm-info
{
"type": "object",
"title": "System Insights TPM Info",
"properties": {
"owned": {
"type": "number"
},
"enabled": {
"type": "number"
},
"activated": {
"type": "number"
},
"system_id": {
"type": "string"
},
"product_name": {
"type": "string"
},
"spec_version": {
"type": "string"
},
"collection_time": {
"type": "string"
},
"manufacturer_id": {
"type": "number"
},
"manufacturer_name": {
"type": "string"
},
"manufacturer_version": {
"type": "string"
},
"physical_presence_version": {
"type": "string"
}
}
}
system-insights-uptime
{
"type": "object",
"title": "System Insights Uptime",
"properties": {
"days": {
"type": "integer"
},
"hours": {
"type": "integer"
},
"minutes": {
"type": "integer"
},
"seconds": {
"type": "integer"
},
"system_id": {
"type": "string"
},
"total_seconds": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-usb-devices
{
"type": "object",
"title": "System Insights USB Devices",
"properties": {
"class": {
"type": "string"
},
"model": {
"type": "string"
},
"serial": {
"type": "string"
},
"vendor": {
"type": "string"
},
"version": {
"type": "string"
},
"model_id": {
"type": "string"
},
"protocol": {
"type": "string"
},
"subclass": {
"type": "string"
},
"usb_port": {
"type": "integer"
},
"removable": {
"type": "integer"
},
"system_id": {
"type": "string"
},
"vendor_id": {
"type": "string"
},
"usb_address": {
"type": "integer"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-user-groups
{
"type": "object",
"title": "System Insights User Groups",
"properties": {
"gid": {
"type": "string"
},
"uid": {
"type": "string"
},
"system_id": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-user-ssh-keys
{
"type": "object",
"title": "System Insights User SSH Keys",
"properties": {
"uid": {
"type": "string"
},
"path": {
"type": "string"
},
"encrypted": {
"type": "integer"
},
"system_id": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-userassist
{
"type": "object",
"title": "System Insights User Assist",
"properties": {
"sid": {
"type": "string"
},
"path": {
"type": "string"
},
"count": {
"type": "number"
},
"system_id": {
"type": "string"
},
"collection_time": {
"type": "string"
},
"last_execution_time": {
"type": "number"
}
}
}
system-insights-users
{
"type": "object",
"title": "System Insights Users",
"example": {
"gid": "55",
"uid": "55",
"type": "",
"uuid": "FFFFEEEE-DDDD-CCCC-BBBB-AAAA00000037",
"shell": "/usr/bin/false",
"username": "_appleevents",
"directory": "/var/empty",
"system_id": "5c9e51a13c5146f89bae12d9",
"gid_signed": "55",
"uid_signed": "55",
"description": "AppleEvents Daemon",
"collection_time": "2019-06-03T19:41:29.710Z"
},
"properties": {
"gid": {
"type": "string"
},
"uid": {
"type": "string"
},
"type": {
"type": "string"
},
"uuid": {
"type": "string"
},
"admin": {
"type": "boolean",
"description": "Indicates this account has local administrator privileges"
},
"shell": {
"type": "string"
},
"managed": {
"type": "boolean",
"description": "Indicates this account belongs to a JumpCloud-managed user"
},
"username": {
"type": "string"
},
"directory": {
"type": "string"
},
"real_user": {
"type": "boolean",
"description": "Indicates this account represents an interactive user account vs. a system or daemon account"
},
"suspended": {
"type": "boolean",
"description": "Indicates this account is suspended or locked out"
},
"system_id": {
"type": "string"
},
"ad_managed": {
"type": "boolean",
"description": "Indicates this account belongs to a AD-managed user"
},
"gid_signed": {
"type": "string"
},
"last_login": {
"type": "string",
"description": "A Unix timestamp showing the last time this user logged in"
},
"uid_signed": {
"type": "string"
},
"description": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-wifi-networks
{
"type": "object",
"title": "System Insights WiFi Networks",
"properties": {
"ssid": {
"type": "string"
},
"roaming": {
"type": "number"
},
"disabled": {
"type": "number"
},
"passpoint": {
"type": "number"
},
"system_id": {
"type": "string"
},
"auto_login": {
"type": "number"
},
"network_name": {
"type": "string"
},
"security_type": {
"type": "string"
},
"captive_portal": {
"type": "number"
},
"last_connected": {
"type": "number"
},
"collection_time": {
"type": "string"
},
"possibly_hidden": {
"type": "number"
},
"roaming_profile": {
"type": "string"
},
"temporarily_disabled": {
"type": "number"
}
}
}
system-insights-wifi-status
{
"type": "object",
"title": "System Insights WiFi Status",
"properties": {
"mode": {
"type": "string"
},
"rssi": {
"type": "number"
},
"ssid": {
"type": "string"
},
"bssid": {
"type": "string"
},
"noise": {
"type": "number"
},
"channel": {
"type": "number"
},
"interface": {
"type": "string"
},
"system_id": {
"type": "string"
},
"channel_band": {
"type": "number"
},
"country_code": {
"type": "string"
},
"network_name": {
"type": "string"
},
"channel_width": {
"type": "number"
},
"security_type": {
"type": "string"
},
"transmit_rate": {
"type": "string"
},
"collection_time": {
"type": "string"
}
}
}
system-insights-windows-security-center
{
"type": "object",
"title": "System Insights Windows Security Center",
"properties": {
"firewall": {
"type": "string"
},
"antivirus": {
"type": "string"
},
"system_id": {
"type": "string"
},
"autoupdate": {
"type": "string"
},
"antispyware": {
"type": "string"
},
"collection_time": {
"type": "string"
},
"internet_settings": {
"type": "string"
},
"user_account_control": {
"type": "string"
},
"windows_security_center_service": {
"type": "string"
}
}
}
system-insights-windows-security-products
{
"type": "object",
"title": "System Insights Windows Security Products",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"state": {
"type": "string"
},
"system_id": {
"type": "string"
},
"collection_time": {
"type": "string"
},
"state_timestamp": {
"type": "string"
},
"remediation_path": {
"type": "string"
},
"signatures_up_to_date": {
"type": "number"
}
}
}
systemfdekey
{
"type": "object",
"title": "SystemFDEKey",
"required": [
"key"
],
"properties": {
"key": {
"type": "string"
}
}
}
workday-fields
{
"type": "object",
"title": "Workday Fields",
"properties": {
"name": {
"type": "string"
},
"reportUrl": {
"type": "string"
}
}
}
workday-input
{
"type": "object",
"title": "Workday Input",
"example": {
"auth": {
"basic": {
"password": "in tempor ipsum quis",
"username": "mollit ex"
},
"oauth": {
"code": "non laborum dolore"
}
},
"name": "dolore tempor",
"reportUrl": "est sit laboris"
},
"properties": {
"auth": {
"$ref": "#/components/schemas/auth-input"
},
"name": {
"type": "string"
},
"reportUrl": {
"type": "string"
}
}
}
workday-output
{
"type": "object",
"title": "Workday Output",
"properties": {
"id": {
"type": "string"
},
"auth": {
"type": "object",
"properties": {
"basic": {
"$ref": "#/components/schemas/auth-info"
},
"oauth": {
"$ref": "#/components/schemas/auth-info"
}
}
},
"name": {
"type": "string"
},
"reportUrl": {
"type": "string"
},
"lastImport": {
"type": "string"
}
}
}
workday-worker
{
"type": "object",
"title": "Workday Worker",
"properties": {
"email": {
"type": "string"
},
"lastName": {
"type": "string"
},
"username": {
"type": "string"
},
"firstName": {
"type": "string"
},
"attributes": {
"type": "object"
}
}
}