JumpCloud

Directory platform for IT management

docs.jumpcloud.com/api ↗

Version

2.0

OpenAPI

3.0.0

Endpoints

416

Schemas

669

Updated

3 days ago

Identity identity directory it-management

Use this API in your AI agent

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

Get API Key

Server URLs

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

Authentication

apiKey

Endpoints

Clear filters

GET POST PUT PATCH DELETE

Active directory 2 endpoints

POST /activedirectories Create a new Active Directory

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

operationId: activedirectories_post

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "$ref": "#/components/requestBodies/active-directory"
}

Responses

201

POST /activedirectories

POST /activedirectories/{activedirectory_id}/agents Create a new Active Directory Agent

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

operationId: activedirectories_agentsPost

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/active-directory-agent"
      }
    }
  }
}

Responses

201

POST /activedirectories/{activedirectory_id}/agents

Administrators 1 endpoints

POST /administrators/{id}/organizationlinks Allow Adminstrator access to an Organization.

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

operationId: administratorOrganizations_createByAdministrator

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/AdministratorOrganizationLinkReq"
      }
    }
  }
}

Responses

201 OK

400

401

403

404

500

POST /administrators/{id}/organizationlinks

Apple mdm 9 endpoints

POST /applemdms/{apple_mdm_id}/devices/{device_id}/clearActivationLock Clears the Activation Lock for a Device

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

operationId: applemdms_devicesClearActivationLock

Parameters

Name	In	Required	Type	Description
		optional

Responses

204

400

401

403

404

409

500

POST /applemdms/{apple_mdm_id}/devices/{device_id}/clearActivationLock

POST /applemdms/{apple_mdm_id}/devices/{device_id}/erase Erase Device

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

operationId: applemdms_deviceserase

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ApplemdmsDeviceseraseRequest"
      }
    }
  }
}

Responses

204

400

401

403

404

409

500

POST /applemdms/{apple_mdm_id}/devices/{device_id}/erase

POST /applemdms/{apple_mdm_id}/devices/{device_id}/lock Lock Device

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

operationId: applemdms_deviceslock

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ApplemdmsDeviceslockRequest"
      }
    }
  }
}

Responses

204

400

401

403

404

409

500

POST /applemdms/{apple_mdm_id}/devices/{device_id}/lock

POST /applemdms/{apple_mdm_id}/devices/{device_id}/osUpdateStatus Request the status of an OS update for a device

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

operationId: applemdms_devicesOSUpdateStatus

Parameters

Name	In	Required	Type	Description
		optional

Responses

204

400

401

403

404

409

500

POST /applemdms/{apple_mdm_id}/devices/{device_id}/osUpdateStatus

POST /applemdms/{apple_mdm_id}/devices/{device_id}/refreshActivationLockInformation Refresh activation lock information for a device

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

operationId: applemdms_devicesRefreshActivationLockInformation

Parameters

Name	In	Required	Type	Description
		optional

Responses

204

400

401

403

404

409

500

POST /applemdms/{apple_mdm_id}/devices/{device_id}/refreshActivationLockInformation

POST /applemdms/{apple_mdm_id}/devices/{device_id}/restart Restart Device

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"]}' ```

operationId: applemdms_devicesrestart

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ApplemdmsDevicesrestartRequest"
      }
    }
  },
  "x-examples": {
    "example-1": {
      "kextPaths": [
        "/path/to/kext1",
        "/path/to/kext2"
      ]
    }
  }
}

Responses

204

400

401

403

404

409

500

POST /applemdms/{apple_mdm_id}/devices/{device_id}/restart

POST /applemdms/{apple_mdm_id}/devices/{device_id}/scheduleOSUpdate Schedule an OS update for a device

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

operationId: applemdms_devicesScheduleOSUpdate

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ScheduleOSUpdate"
      }
    }
  }
}

Responses

204

400

401

403

404

409

500

POST /applemdms/{apple_mdm_id}/devices/{device_id}/scheduleOSUpdate

POST /applemdms/{apple_mdm_id}/devices/{device_id}/shutdown Shut Down Device

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

operationId: applemdms_devicesshutdown

Parameters

Name	In	Required	Type	Description
		optional

Responses

204

400

401

403

404

409

500

POST /applemdms/{apple_mdm_id}/devices/{device_id}/shutdown

POST /applemdms/{apple_mdm_id}/refreshdepdevices Refresh DEP Devices

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

operationId: applemdms_refreshdepdevices

Parameters

Name	In	Required	Type	Description
		optional

Responses

204

400

401

403

404

409

500

POST /applemdms/{apple_mdm_id}/refreshdepdevices

Applications 2 endpoints

POST /applications/{application_id}/import/jobs Create an import job

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

operationId: import_create

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ImportUsersRequest"
      }
    }
  }
}

Responses

200 OK

400

401

403

404

500

POST /applications/{application_id}/import/jobs

POST /applications/{application_id}/logo Save application 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}' ```

operationId: applications_postLogo

Parameters

Name	In	Required	Type	Description
application_id	path	required	string
		optional

Request Body

{
  "content": {
    "multipart/form-data": {
      "schema": {
        "$ref": "#/components/schemas/ApplicationsPostLogoRequest"
      }
    }
  }
}

Responses

204 NO_CONTENT

400

401

403

404

409

500

POST /applications/{application_id}/logo

Authentication policies 1 endpoints

POST /authn/policies Create an Authentication Policy

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

operationId: authnpolicies_post

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "$ref": "#/components/requestBodies/AuthnPolicy"
}

Responses

201 Created

400

401

403

404

409

500

POST /authn/policies

Bulk job requests 4 endpoints

POST /bulk/user/expires Bulk Expire Users

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

operationId: bulk_userExpires

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/BulkUserExpiresRequest"
      }
    }
  }
}

Responses

201 Created

POST /bulk/user/expires

POST /bulk/user/unlocks Bulk Unlock Users

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

operationId: bulk_userUnlocks

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/BulkUserUnlocksRequest"
      }
    }
  }
}

Responses

201 Created

POST /bulk/user/unlocks

POST /bulk/users Bulk Users Create

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" } ] } ]' ```

operationId: bulk_usersCreate

Parameters

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.

Request Body

{
  "$ref": "#/components/requestBodies/bulk-user-createArray"
}

Responses

201

POST /bulk/users

POST /bulk/userstates Create Scheduled Userstate Job

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

operationId: bulk_userStatesCreate

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/bulk-scheduled-statechange-create"
      }
    }
  }
}

Responses

201 Created

400 Bad Request

401 Unauthorized

500 Internal Server Error

POST /bulk/userstates

Custom emails 1 endpoints

POST /customemails Create custom email configuration

Create the custom email configuration for the specified custom email type. This action is only available to paying customers.

operationId: customEmails_create

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "$ref": "#/components/requestBodies/CustomEmail"
}

Responses

201 OK

400

401

403

404

409

500

POST /customemails

Duo 2 endpoints

POST /duo/accounts Create Duo Account

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

operationId: duo_accountPost

Parameters

Name	In	Required	Type	Description
		optional

Responses

201

400

401

403

404

409

500

POST /duo/accounts

POST /duo/accounts/{account_id}/applications Create Duo Application

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

operationId: duo_applicationPost

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/DuoApplicationReq"
      }
    }
  }
}

Responses

201

400

401

403

404

409

500

POST /duo/accounts/{account_id}/applications

G suite 3 endpoints

POST /gsuites/{gsuite_id}/domains Add a domain to a Google Workspace integration instance

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

operationId: GSuite_addDomain

Parameters

Name	In	Required	Type	Description
gsuite_id	path	required	string	Id for the specific Google Workspace directory sync integration instance.
domain	query	optional	string

Responses

default An unexpected error response.

200 A successful response.

201 Created

401 Unauthorized

403 Forbidden

404 Not Found

409 Conflict

500 Internal Server Error

POST /gsuites/{gsuite_id}/domains

POST /gsuites/{gsuite_id}/import/schedules Create a Scheduled Job

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

operationId: GSuite_importSchedulesCreate

Parameters

Name	In	Required	Type	Description
gsuite_id	path	required	string	ObjectID of the Google Workspace integration

Responses

default An unexpected error response.

200 A successful response.

201 Created

401 Unauthorized

403 Forbidden

404 Not Found

500 Internal Server Error

POST /gsuites/{gsuite_id}/import/schedules

POST /gsuites/{gsuite_id}/translationrules Create a new G Suite Translation Rule

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

operationId: translationRules_gSuitePost

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GSuiteTranslationRuleRequest"
      }
    }
  }
}

Responses

201

POST /gsuites/{gsuite_id}/translationrules

Google emm 9 endpoints

POST /google-emm/devices/{deviceId}/erase-device Erase the Android 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}' \ ```

operationId: Devices_EraseDevice

Parameters

Name	In	Required	Type	Description
deviceId	path	required	string

Request Body

{
  "$ref": "#/components/requestBodies/Devices_EraseDeviceBody"
}

Responses

200 A successful response.

POST /google-emm/devices/{deviceId}/erase-device

POST /google-emm/devices/{deviceId}/lock Lock device

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

operationId: Devices_LockDevice

Parameters

Name	In	Required	Type	Description
deviceId	path	required	string

Request Body

{
  "$ref": "#/components/requestBodies/Devices_EraseDeviceBody"
}

Responses

200 A successful response.

POST /google-emm/devices/{deviceId}/lock

POST /google-emm/devices/{deviceId}/reboot Reboot device

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

operationId: Devices_RebootDevice

Parameters

Name	In	Required	Type	Description
deviceId	path	required	string

Request Body

{
  "$ref": "#/components/requestBodies/Devices_EraseDeviceBody"
}

Responses

200 A successful response.

POST /google-emm/devices/{deviceId}/reboot

POST /google-emm/devices/{deviceId}/resetpassword Reset Password of a device

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

operationId: Devices_ResetPassword

Parameters

Name	In	Required	Type	Description
deviceId	path	required	string

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/DevicesResetPasswordRequest"
      }
    }
  },
  "required": true
}

Responses

200 A successful response.

POST /google-emm/devices/{deviceId}/resetpassword

POST /google-emm/enrollment-tokens Create an enrollment token

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

operationId: EnrollmentTokens_CreateEnrollmentToken

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/jumpcloud.google_emm.CreateEnrollmentTokenRequest"
      }
    }
  },
  "required": true
}

Responses

200 A successful response.

POST /google-emm/enrollment-tokens

POST /google-emm/enterprises Create a Google Enterprise

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

operationId: Enterprises_CreateEnterprise

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/jumpcloud.google_emm.CreateEnterpriseRequest"
      }
    }
  },
  "required": true
}

Responses

200 A successful response.

POST /google-emm/enterprises

POST /google-emm/enterprises/{enterpriseObjectId}/enrollment-tokens Create an enrollment token for a given enterprise

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

operationId: EnrollmentTokens_CreateEnterprisesEnrollmentToken

Parameters

Name	In	Required	Type	Description
enterpriseObjectId	path	required	string

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/EnrollmentTokensCreateEnterprisesEnrollmentTokenRequest"
      }
    }
  },
  "required": true
}

Responses

200 A successful response.

POST /google-emm/enterprises/{enterpriseObjectId}/enrollment-tokens

POST /google-emm/signup-urls Get a Signup URL to enroll Google enterprise

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

operationId: SignupURLs_Create

Responses

200 A successful response.

POST /google-emm/signup-urls

POST /google-emm/web-tokens Get a web token to render Google Play iFrame

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

operationId: WebTokens_CreateWebToken

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/jumpcloud.google_emm.CreateWebTokenRequest"
      }
    }
  },
  "required": true
}

Responses

200 A successful response.

POST /google-emm/web-tokens

Graph 18 endpoints

POST /activedirectories/{activedirectory_id}/associations Manage the associations of an Active Directory instance

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

operationId: graph_activeDirectoryAssociationsPost

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GraphOperation-ActiveDirectory"
      }
    }
  }
}

Responses

204

POST /activedirectories/{activedirectory_id}/associations

POST /applications/{application_id}/associations Manage the associations of an Application

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

operationId: graph_applicationAssociationsPost

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GraphOperation-Application"
      }
    }
  }
}

Responses

204 OK

POST /applications/{application_id}/associations

POST /commands/{command_id}/associations Manage the associations of a Command

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

operationId: graph_commandAssociationsPost

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GraphOperation-Command"
      }
    }
  }
}

Responses

204 OK

POST /commands/{command_id}/associations

POST /gsuites/{gsuite_id}/associations Manage the associations of a G Suite instance

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

operationId: graph_gSuiteAssociationsPost

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GraphOperation-GSuite"
      }
    }
  }
}

Responses

204 OK

POST /gsuites/{gsuite_id}/associations

POST /identity-provider/policies/{idp_routing_policy_id}/associations Manage the associations of a routing policy

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

operationId: graph_idpRoutingPolicyAssociationsPost

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GraphOperation-IDPRoutingPolicy"
      }
    }
  }
}

Responses

204 OK

POST /identity-provider/policies/{idp_routing_policy_id}/associations

POST /ldapservers/{ldapserver_id}/associations Manage the associations of a LDAP Server

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

operationId: graph_ldapServerAssociationsPost

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GraphOperation-LdapServer"
      }
    }
  }
}

Responses

204 OK

POST /ldapservers/{ldapserver_id}/associations

POST /office365s/{office365_id}/associations Manage the associations of an Office 365 instance

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

operationId: graph_office365AssociationsPost

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GraphOperation-Office365"
      }
    }
  }
}

Responses

204 OK

POST /office365s/{office365_id}/associations

POST /policies/{policy_id}/associations Manage the associations of a Policy

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

operationId: graph_policyAssociationsPost

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GraphOperation-Policy"
      }
    }
  }
}

Responses

204

POST /policies/{policy_id}/associations

POST /policygroups/{group_id}/associations Manage the associations of a Policy Group

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

operationId: graph_policyGroupAssociationsPost

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GraphOperation-PolicyGroup"
      }
    }
  }
}

Responses

204 OK

POST /policygroups/{group_id}/associations

POST /policygroups/{group_id}/members Manage the members of a Policy Group

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

operationId: graph_policyGroupMembersPost

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GraphOperation-PolicyGroup-Member"
      }
    }
  }
}

Responses

204 OK

POST /policygroups/{group_id}/members

POST /radiusservers/{radiusserver_id}/associations Manage the associations of a RADIUS Server

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

operationId: graph_radiusServerAssociationsPost

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GraphOperation-RadiusServer"
      }
    }
  }
}

Responses

204 OK

POST /radiusservers/{radiusserver_id}/associations

POST /softwareapps/{software_app_id}/associations Manage the associations of a software application.

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

operationId: graph_softwareappsAssociationsPost

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GraphOperation-SoftwareApp"
      }
    }
  }
}

Responses

204

POST /softwareapps/{software_app_id}/associations

POST /systemgroups/{group_id}/associations Manage the associations of a System Group

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

operationId: graph_systemGroupAssociationsPost

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GraphOperation-SystemGroup"
      }
    }
  }
}

Responses

204 OK

POST /systemgroups/{group_id}/associations

POST /systemgroups/{group_id}/members Manage the members of a System Group

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

operationId: graph_systemGroupMembersPost

Parameters

Name	In	Required	Type	Description
		optional
		optional
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GraphOperation-SystemGroup-Member"
      }
    }
  }
}

Responses

204 OK

POST /systemgroups/{group_id}/members

POST /systems/{system_id}/associations Manage associations of a System

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

operationId: graph_systemAssociationsPost

Parameters

Name	In	Required	Type	Description
		optional
		optional
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GraphOperation-System"
      }
    }
  }
}

Responses

204 OK

POST /systems/{system_id}/associations

POST /usergroups/{group_id}/associations Manage the associations of a User Group

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

operationId: graph_userGroupAssociationsPost

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GraphOperation-UserGroup"
      }
    }
  }
}

Responses

204 OK

POST /usergroups/{group_id}/associations

POST /usergroups/{group_id}/members Manage the members of a User Group

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

operationId: graph_userGroupMembersPost

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GraphOperation-UserGroup-Member"
      }
    }
  }
}

Responses

204 OK

POST /usergroups/{group_id}/members

POST /users/{user_id}/associations Manage the associations of a User

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

operationId: graph_userAssociationsPost

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GraphOperation-User"
      }
    }
  }
}

Responses

204 OK

POST /users/{user_id}/associations

Ip lists 1 endpoints

POST /iplists Create IP List

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" ] }' ```

operationId: iplists_post

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "$ref": "#/components/requestBodies/IPListRequest"
}

Responses

201 Created

400

401

403

404

409

500

POST /iplists

Microsoft mdm 1 endpoints

POST /microsoft-mdm/configuration-files This endpoint provides a zipped configuration file intended for use with Microsoft Configuration Designer to create a Provisioning Package (PPKG) for bulk MDM enrollment.

This endpoint allows you to download the config file.

operationId: Enrollments_DownloadConfigFiles

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/jumpcloud.microsoft_mdm.DownloadConfigFilesRequest"
      }
    }
  },
  "required": true
}

Responses

200 OK

POST /microsoft-mdm/configuration-files

Office 365 2 endpoints

POST /office365s/{office365_id}/domains Add a domain to an Office 365 instance

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

operationId: Domains_Insert

Parameters

Name	In	Required	Type	Description
office365_id	path	required	string	Id for the specific M365/Azure AD directory sync integration instance.

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/DomainsInsertRequest"
      }
    }
  },
  "required": true
}

Responses

default An unexpected error response.

200 A successful response.

201 Created

401

403

404

409

500

POST /office365s/{office365_id}/domains

POST /office365s/{office365_id}/translationrules Create a new Office 365 Translation Rule

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

operationId: translationRules_office365Post

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Office365TranslationRuleRequest"
      }
    }
  }
}

Responses

201

400

POST /office365s/{office365_id}/translationrules

Policies 1 endpoints

POST /policies Create a new Policy

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

operationId: policies_post

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PolicyCreateRequest"
      }
    }
  }
}

Responses

201 Created

POST /policies

Policy groups 1 endpoints

POST /policygroups Create a new Policy Group

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

operationId: PolicyGroups_createNew

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "$ref": "#/components/requestBodies/PolicyGroupData"
}

Responses

201 Created

POST /policygroups

Providers 5 endpoints

POST /providers/{provider_id}/integrations/autotask Creates a new Autotask integration for the provider

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.

operationId: autotask_createConfiguration

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/AutotaskIntegrationReq"
      }
    }
  }
}

Responses

201 Created

400

401

403

404

409

422 Unprocessable Entity. The server failed to validate credentials with ConnectWise.

500

POST /providers/{provider_id}/integrations/autotask

POST /providers/{provider_id}/integrations/connectwise Creates a new ConnectWise integration for the provider

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.

operationId: connectwise_createConfiguration

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ConnectwiseIntegrationReq"
      }
    }
  }
}

Responses

201 Created

400

401

403

404

409

422 Unprocessable Entity. The server failed to validate credentials with ConnectWise.

500

POST /providers/{provider_id}/integrations/connectwise

POST /providers/{provider_id}/integrations/syncro Creates a new Syncro integration for the provider

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.

operationId: syncro_createConfiguration

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SyncroIntegrationReq"
      }
    }
  }
}

Responses

201 Created

400

401

403

404

409

422 Unprocessable Entity. The server failed to validate credentials with Syncro.

500

POST /providers/{provider_id}/integrations/syncro

POST /providers/{provider_id}/administrators Create a new Provider Administrator

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`.

operationId: providers_postAdmins

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ProviderAdminReq"
      }
    }
  }
}

Responses

200

401

POST /providers/{provider_id}/administrators

POST /providers/{provider_id}/organizations Create Provider Organization

This endpoint creates a new organization under the provider

operationId: providerOrganizations_createOrg

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/CreateOrganization"
      }
    }
  }
}

Responses

201 CREATED

400 A 'Bad Request' error will be returned in one of the following scenarios: * The request payload contains fields that are not allowed (only 'name' and 'maxSystemUsers' are allowed). * The user creating the org specifies 'maxSystemUsers' in the request payload but does not have the organizations.billing scope. * The required field 'name' is missing from the request payload or is an empty string or a string that only contains whitespaces.

403 A 'Forbidden' error will be returned if organization creation is disabled for the provider.

500

POST /providers/{provider_id}/organizations

Push verification 1 endpoints

POST /users/{userId}/pushendpoints/{pushEndpointId}/verify Send Push Verification message

Endpoint for sending a verification push notification

operationId: PushVerifications_Start

Parameters

Name	In	Required	Type	Description
userId	path	required	string
pushEndpointId	path	required	string

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PushVerificationsStartRequest"
      }
    }
  },
  "required": true
}

Responses

default An unexpected error response.

200 OK

400 Bad Request

401 Unauthorized

403 Forbidden

429 Too Many Requests

500 Internal Server Error

POST /users/{userId}/pushendpoints/{pushEndpointId}/verify

Samba domains 1 endpoints

POST /ldapservers/{ldapserver_id}/sambadomains Create Samba Domain

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

operationId: ldapservers_sambaDomainsPost

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "$ref": "#/components/requestBodies/samba-domain"
}

Responses

201

POST /ldapservers/{ldapserver_id}/sambadomains

Software apps 4 endpoints

POST /softwareapps Create a Software Application that will be managed by JumpCloud.

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"}] }' ```

operationId: softwareApps_post

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/software-app"
      }
    }
  }
}

Responses

201 Created

POST /softwareapps

POST /softwareapps/validate Validate Installation Packages

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 ```

operationId: Validator_ValidateApplicationInstallPackage

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/jumpcloud.package_validator.ValidateApplicationInstallPackageRequest"
      }
    }
  },
  "required": true
}

Responses

200 OK

400 Bad Request

401 Unauthorized

403 Forbidden

404 Not Found

500 Internal Server Error

POST /softwareapps/validate

POST /softwareapps/{software_app_id}/reclaim-licenses Reclaim Licenses for a Software Application.

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

operationId: softwareApps_reclaimLicenses

Responses

200 Reclaim Licenses Response

POST /softwareapps/{software_app_id}/reclaim-licenses

POST /softwareapps/{software_app_id}/retry-installation Retry Installation for a Software Application

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>, ...}"}' ```

operationId: softwareApps_retryInstallation

Responses

204 No Content

400

POST /softwareapps/{software_app_id}/retry-installation

System groups 2 endpoints

POST /systemgroups Create a new System Group

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

operationId: SystemGroups_createNewGroup

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SystemGroupPost"
      }
    }
  }
}

Responses

201 Created

POST /systemgroups

POST /systemgroups/{group_id}/suggestions Apply Suggestions for a System Group

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"] }' ```

operationId: SystemGroups_applySuggestions

Parameters

Name	In	Required	Type	Description
		optional
group_id	path	required	string	ID of the group

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SystemGroupsApplySuggestionsRequest"
      }
    }
  },
  "required": true
}

Responses

200 OK

POST /systemgroups/{group_id}/suggestions

Systems 2 endpoints

POST /accessrequests Create Access Request

Endpoint for adding a new access request

operationId: AccessRequestApi_CreateAccessRequest

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/jumpcloud.ingresso.CreateAccessRequestsRequest"
      }
    }
  },
  "required": true
}

Responses

default An unexpected error response.

200 A successful response.

POST /accessrequests

POST /accessrequests/{accessId}/revoke Revoke access request by id

Endpoint for revoking access request by id

operationId: AccessRequestApi_RevokeAccessRequest

Parameters

Name	In	Required	Type	Description
accessId	path	required	string

Responses

default An unexpected error response.

200 A successful response.

POST /accessrequests/{accessId}/revoke

User groups 2 endpoints

POST /usergroups Create a new User Group

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

operationId: UserGroups_createNewGroup

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/UserGroupPost"
      }
    }
  }
}

Responses

201 Created

POST /usergroups

POST /usergroups/{group_id}/suggestions Apply Suggestions for a User Group

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"] }' ```

operationId: UserGroups_applySuggestions

Parameters

Name	In	Required	Type	Description
		optional
group_id	path	required	string	ID of the group

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/UserGroupsApplySuggestionsRequest"
      }
    }
  },
  "required": true
}

Responses

200 OK

POST /usergroups/{group_id}/suggestions

Workday import 3 endpoints

POST /workdays Create new Workday

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

operationId: workdays_post

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/workday-input"
      }
    }
  }
}

Responses

201

POST /workdays

POST /workdays/{workday_id}/auth Authorize Workday

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

operationId: workdays_authorize

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/auth-input-object"
      }
    }
  }
}

Responses

204

POST /workdays/{workday_id}/auth

POST /workdays/{workday_id}/import Workday 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"} ] } ] ```

operationId: workdays_import

Parameters

Name	In	Required	Type	Description
		optional

Request Body

{
  "$ref": "#/components/requestBodies/bulk-user-createArray"
}

Responses

201

POST /workdays/{workday_id}/import

Schemas

object ADE

{
  "type": "object",
  "title": "ADE",
  "properties": {
    "setupOptions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SetupAssistantOption"
      },
      "description": "A list of configured setup options for this enrollment."
    },
    "welcomeScreen": {
      "$ref": "#/components/schemas/DEPWelcomeScreen"
    },
    "setupAssistantOptions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DEPSetupAssistantOption"
      },
      "description": "A Setup Option wrapped as an object",
      "x-deprecated": true
    },
    "enableZeroTouchEnrollment": {
      "type": "boolean",
      "description": "A toggle to determine if ADE registered devices should go through JumpCloud Zero Touch Enrollment."
    },
    "defaultDeviceGroupObjectIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "description": "An array of ObjectIDs identifying the default device groups for this specific type (based on the OS family) of automated device enrollment. Currently, only a single DeviceGroupID is supported."
    }
  }
}

object ADES

{
  "type": "object",
  "title": "ADES",
  "properties": {
    "ios": {
      "$ref": "#/components/schemas/ADE"
    },
    "macos": {
      "$ref": "#/components/schemas/ADE"
    }
  }
}

object AccessRequestApiRevokeAccessRequestResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object AccessRequestApiUpdateAccessRequestRequest

{
  "type": "object",
  "properties": {
    "expiry": {
      "type": "string",
      "format": "date-time"
    },
    "remarks": {
      "type": "string"
    },
    "additionalAttributes": {
      "type": "object"
    },
    "organizationObjectId": {
      "type": "string",
      "format": "byte"
    }
  }
}

object AccessRequestApiUpdateAccessRequestResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

array ActivedirectoriesAgentsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/active-directory-agent-list"
  }
}

array ActivedirectoriesListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/active-directory"
  }
}

object Address

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "maxLength": 1024
    },
    "poBox": {
      "type": "string",
      "maxLength": 1024
    },
    "region": {
      "type": "string",
      "maxLength": 1024
    },
    "country": {
      "type": "string",
      "maxLength": 1024
    },
    "locality": {
      "type": "string",
      "maxLength": 1024
    },
    "postalCode": {
      "type": "string",
      "maxLength": 1024
    },
    "streetAddress": {
      "type": "string",
      "maxLength": 1024
    },
    "extendedAddress": {
      "type": "string",
      "maxLength": 1024
    }
  }
}

object Administrator

{
  "type": "object",
  "title": "Administrator",
  "example": {
    "id": "0123456789abcdef01234567",
    "email": "joe@example.com",
    "lastname": "Blough",
    "firstname": "Joe",
    "registered": false,
    "enableMultiFactor": true
  },
  "properties": {
    "id": {
      "type": "string"
    },
    "role": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "lastname": {
      "type": "string"
    },
    "roleName": {
      "type": "string"
    },
    "apiKeySet": {
      "type": "boolean"
    },
    "firstname": {
      "type": "string"
    },
    "suspended": {
      "type": "boolean"
    },
    "registered": {
      "type": "boolean"
    },
    "apiKeyAllowed": {
      "type": "boolean"
    },
    "enableMultiFactor": {
      "type": "boolean"
    },
    "organizationAccessTotal": {
      "type": "number"
    }
  }
}

object AdministratorOrganizationLink

{
  "type": "object",
  "title": "AdministratorOrganizationLink",
  "example": {
    "organization": "6230a0d26a4e4bc86c6b36f1",
    "administrator": "6230a0c233a6cbea7c470398"
  },
  "properties": {
    "organization": {
      "type": "string",
      "description": "The identifier for an organization"
    },
    "administrator": {
      "type": "string",
      "description": "The identifier for an administrator"
    }
  }
}

object AdministratorOrganizationLinkReq

{
  "type": "object",
  "title": "AdministratorOrganizationLinkReq",
  "example": {
    "organization": "6230a0d26a4e4bc86c6b36f1"
  },
  "properties": {
    "organization": {
      "type": "string",
      "description": "The identifier for an organization to link this administrator to."
    }
  }
}

array AdministratorOrganizationsListByAdministratorResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/AdministratorOrganizationLink"
  }
}

array AdministratorOrganizationsListByOrganizationResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/AdministratorOrganizationLink"
  }
}

object AnyValue

{
  "description": "Can be any value - string, number, boolean, array or object."
}

object AppleMDM

{
  "type": "object",
  "title": "AppleMDM",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "ObjectId uniquely identifying an MDM Enrollment,"
    },
    "dep": {
      "$ref": "#/components/schemas/DEP"
    },
    "ades": {
      "$ref": "#/components/schemas/ADES"
    },
    "name": {
      "type": "string",
      "maxLength": 255,
      "description": "A friendly name to identify this enrollment.  Not required to be unique."
    },
    "organization": {
      "type": "string",
      "description": "The identifier for an organization"
    },
    "apnsPushTopic": {
      "type": "string",
      "description": "The push topic assigned to this enrollment by Apple after uploading the Signed CSR plist."
    },
    "apnsCertExpiry": {
      "type": "string",
      "description": "The expiration date and time for the APNS Certificate."
    },
    "depServerTokenState": {
      "enum": [
        "unknown",
        "missing",
        "valid",
        "expired"
      ],
      "type": "string",
      "description": "The state of the dep server token, presence and expiry."
    },
    "defaultSystemGroupID": {
      "type": "string",
      "description": "ObjectId uniquely identifying the MDM default System Group.",
      "x-deprecated": true
    },
    "depAccessTokenExpiry": {
      "type": "string",
      "description": "The expiration date and time for the DEP Access Token. This aligns with the DEP Server Token State."
    },
    "appleCertSerialNumber": {
      "type": "string",
      "description": "The serial number of the Apple signed certificate associated to the Device Manager."
    },
    "appleCertCreatorAppleID": {
      "type": "string",
      "description": "The Apple ID of the admin who created the Apple signed certificate associated to the Device Manager."
    },
    "allowMobileUserEnrollment": {
      "type": "boolean",
      "description": "A toggle to allow mobile device enrollment for an organization."
    },
    "defaultIosUserEnrollmentDeviceGroupID": {
      "type": "string",
      "description": "ObjectId uniquely identifying the MDM default iOS user enrollment device group."
    }
  }
}

object ApplemdmsDevicesClearActivationLock500Response

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

object ApplemdmsDevicesClearActivationLockResponse

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

object ApplemdmsDevicesOsUpdateStatusResponse

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

object ApplemdmsDevicesRefreshActivationLockInformation500Response

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

object ApplemdmsDevicesRefreshActivationLockInformationResponse

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

object ApplemdmsDevicesScheduleOsUpdateResponse

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

object ApplemdmsDeviceserase500Response

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

object ApplemdmsDeviceseraseRequest

{
  "type": "object",
  "properties": {
    "pin": {
      "type": "string",
      "example": "123456",
      "pattern": "^[0-9]{6}$",
      "description": "6-digit PIN, required for MacOS, to erase the device"
    }
  }
}

object ApplemdmsDeviceseraseResponse

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

array ApplemdmsDeviceslistResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/apple-mdm-device"
  }
}

object ApplemdmsDeviceslock500Response

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

object ApplemdmsDeviceslockRequest

{
  "type": "object",
  "properties": {
    "pin": {
      "type": "string",
      "example": "123456",
      "pattern": "^[0-9]{6}$",
      "description": "6-digit PIN, required for MacOS, to lock the device"
    }
  }
}

object ApplemdmsDeviceslockResponse

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

object ApplemdmsDevicesrestart500Response

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

object ApplemdmsDevicesrestartRequest

{
  "type": "object",
  "properties": {
    "kextPaths": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The string to pass when doing a restart and performing a RebuildKernelCache."
    }
  }
}

object ApplemdmsDevicesrestartResponse

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

object ApplemdmsDevicesshutdown500Response

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

object ApplemdmsDevicesshutdownResponse

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

array ApplemdmsEnrollmentprofileslistResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/AppleMDM"
  }
}

array ApplemdmsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/AppleMDM"
  }
}

object ApplemdmsRefreshdepdevices500Response

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

object ApplemdmsRefreshdepdevicesResponse

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

object ApplicationsGetResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object ApplicationsPostLogoRequest

{
  "type": "object",
  "properties": {
    "image": {
      "type": "string",
      "format": "binary",
      "description": "The file to upload."
    }
  }
}

array Apps

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "osId": {
        "type": "integer",
        "format": "int32",
        "example": 1
      },
      "appVersion": {
        "type": "string",
        "example": "1.1.1"
      }
    }
  }
}

object AuthnPolicy

{
  "type": "object",
  "title": "AuthnPolicy",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string"
    },
    "type": {
      "$ref": "#/components/schemas/AuthnPolicyType"
    },
    "effect": {
      "$ref": "#/components/schemas/AuthnPolicyEffect"
    },
    "targets": {
      "$ref": "#/components/schemas/AuthnPolicyTargets"
    },
    "disabled": {
      "type": "boolean"
    },
    "conditions": {
      "type": "object",
      "description": "Conditions may be added to an authentication policy using the following conditional language:\n\n```\n<conditions> ::= <expression>\n<expression> ::= <deviceEncrypted> | <deviceManaged> | <ipAddressIn> |\n                 <locationIn> | <notExpression> | <allExpression> |\n                 <anyExpression>\n<deviceEncrypted> ::= { \"deviceEncrypted\": <boolean> }\n<deviceManaged> ::= { \"deviceManaged\": <boolean> }\n<ipAddressIn> ::= { \"ipAddressIn\": [ <objectId>, ... ] }\n<locationIn> ::= { \"locationIn\": {\n                     \"countries\": [\n                       <iso_3166_country_code>, ...\n                     ]\n                   }\n                 }\n<notExpression> ::= { \"not\": <expression> }\n<allExpression> ::= { \"all\": [ <expression>, ... ] }\n<anyExpression> ::= { \"any\": [ <expression>, ... ] }\n```\n\nFor example, to add a condition that applies to IP addresses in a given list, the following condition can be added:\n\n```\n{\"ipAddressIn\": [ <ip_list_object_id> ]}\n```\n\nIf you would rather exclude IP addresses in the given lists, the following condition could be added:\n\n```\n{\n  \"not\": {\n    \"ipAddressIn\": [ <ip_list_object_id_1>, <ip_list_object_id_2> ]\n  }\n}\n```\n\nYou may also include more than one condition and choose whether \"all\" or \"any\" of them must be met for the policy to apply:\n\n```\n{\n  \"all\": [\n    {\n      \"ipAddressIn\": [ <ip_list_object_id>, ... ]\n    },\n    {\n      \"deviceManaged\": true\n    },\n    {\n      \"locationIn\": {\n        countries: [ <iso_3166_country_code>, ... ]\n      }\n    }\n  ]\n}\n```"
    },
    "description": {
      "type": "string"
    }
  },
  "description": "This represents an authentication policy.  See the details of each field for valid values and restrictions."
}

object AuthnPolicyEffect

{
  "type": "object",
  "title": "AuthnPolicyEffect",
  "required": [
    "action"
  ],
  "properties": {
    "action": {
      "enum": [
        "allow",
        "deny",
        "unknown"
      ],
      "type": "string"
    },
    "obligations": {
      "$ref": "#/components/schemas/AuthnPolicyObligations"
    }
  },
  "x-examples": {
    "example-deny": {
      "action": "deny"
    },
    "example-allow": {
      "action": "allow"
    },
    "example-allow-with-mfa": {
      "action": "allow",
      "obligations": {
        "mfa": {
          "required": true
        }
      }
    }
  }
}

object AuthnPolicyObligations

{
  "type": "object",
  "title": "AuthnPolicyObligations",
  "properties": {
    "mfa": {
      "type": "object",
      "properties": {
        "required": {
          "type": "boolean"
        }
      }
    },
    "userVerification": {
      "type": "object",
      "properties": {
        "requirement": {
          "enum": [
            "none",
            "optional",
            "required"
          ],
          "type": "string"
        }
      }
    }
  }
}

object AuthnPolicyResourceTarget

{
  "type": "object",
  "title": "AuthnPolicyResourceTarget",
  "required": [
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Object ID of the resource target. If undefined, then all resources of the given type are targeted."
    },
    "type": {
      "enum": [
        "user_portal",
        "application",
        "ldap"
      ],
      "type": "string"
    }
  }
}

object AuthnPolicyTargets

{
  "type": "object",
  "title": "AuthnPolicyTargets",
  "properties": {
    "users": {
      "$ref": "#/components/schemas/AuthnPolicyUserTarget"
    },
    "resources": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AuthnPolicyResourceTarget"
      }
    },
    "userGroups": {
      "$ref": "#/components/schemas/AuthnPolicyUserGroupTarget"
    },
    "userAttributes": {
      "$ref": "#/components/schemas/AuthnPolicyUserAttributeTarget"
    }
  }
}

string AuthnPolicyType

{
  "enum": [
    "user_portal",
    "application",
    "ldap"
  ],
  "type": "string",
  "title": "AuthnPolicyType",
  "default": "user_portal"
}

object AuthnPolicyUserAttributeFilter

{
  "type": "object",
  "title": "AuthnPolicyUserAttributeFilter",
  "properties": {
    "field": {
      "type": "string",
      "description": "The only field that is currently supported is ldap_binding_user"
    },
    "value": {
      "$ref": "#/components/schemas/AnyValue"
    },
    "operator": {
      "enum": [
        "EQ"
      ],
      "type": "string"
    }
  }
}

object AuthnPolicyUserAttributeTarget

{
  "type": "object",
  "title": "AuthnPolicyUserAttributeTarget",
  "properties": {
    "exclusions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AuthnPolicyUserAttributeFilter"
      }
    },
    "inclusions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AuthnPolicyUserAttributeFilter"
      }
    }
  },
  "description": "User attribute targets are currently only supported for LDAP policies."
}

object AuthnPolicyUserGroupTarget

{
  "type": "object",
  "title": "AuthnPolicyUserGroupTarget",
  "properties": {
    "exclusions": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "inclusions": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

object AuthnPolicyUserTarget

{
  "type": "object",
  "title": "AuthnPolicyUserTarget",
  "properties": {
    "inclusions": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

array AuthnpoliciesListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/AuthnPolicy"
  }
}

object 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"
}

object 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"
}

object 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"
}

object 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"
}

object 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"
}

object AutotaskCreateConfiguration422Response

{
  "type": "object",
  "properties": {}
}

object AutotaskCreateConfigurationResponse

{
  "type": "object",
  "required": [
    "integrationId"
  ],
  "properties": {
    "integrationId": {
      "type": "string",
      "description": "The identifier of the created integration"
    }
  }
}

object 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"
}

object 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"
}

object 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"
}

object 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"
}

object AutotaskMappingRequestCompany

{
  "type": "object",
  "required": [
    "id",
    "name"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}

object AutotaskMappingRequestContract

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "nullable": true
    },
    "name": {
      "type": "string",
      "nullable": true
    }
  }
}

object AutotaskMappingRequestOrganization

{
  "type": "object",
  "required": [
    "id",
    "name"
  ],
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1
    },
    "name": {
      "type": "string"
    }
  }
}

object AutotaskMappingRequestService

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "nullable": true
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "nonBillableUsers": {
      "type": "integer",
      "nullable": true
    }
  }
}

object 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"
}

object AutotaskMappingResponseCompany

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}

object AutotaskMappingResponseContract

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}

object AutotaskMappingResponseOrganization

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}

object AutotaskMappingResponseService

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "nonBillableUsers": {
      "type": "integer"
    }
  }
}

object AutotaskRetrieveContractsFieldsResponse

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AutotaskContractField"
      }
    },
    "totalCount": {
      "type": "integer"
    }
  }
}

object AutotaskRetrieveContractsResponse

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AutotaskContract"
      }
    },
    "totalCount": {
      "type": "integer"
    }
  }
}

object AutotaskRetrieveMappingsResponse

{
  "type": "object",
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AutotaskMappingResponse"
      }
    },
    "totalCount": {
      "type": "number"
    }
  }
}

object AutotaskRetrieveServicesResponse

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AutotaskService"
      }
    },
    "totalCount": {
      "type": "integer"
    }
  }
}

object 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"
}

object 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"
}

object 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"
}

object 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."
}

object AutotaskTicketingAlertConfigurationList

{
  "type": "object",
  "required": [
    "records"
  ],
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "alertId": {
                "type": "string"
              }
            }
          },
          {
            "$ref": "#/components/schemas/AutotaskTicketingAlertConfiguration"
          }
        ]
      }
    }
  }
}

object AutotaskTicketingAlertConfigurationOption

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "values": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string"
          },
          "value": {
            "type": "integer"
          }
        }
      }
    }
  }
}

object AutotaskTicketingAlertConfigurationOptions

{
  "type": "object",
  "properties": {
    "options": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AutotaskTicketingAlertConfigurationOption"
      }
    },
    "resources": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AutotaskTicketingAlertConfigurationResource"
      }
    }
  }
}

object 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."
}

object AutotaskTicketingAlertConfigurationResource

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "roles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string"
          },
          "value": {
            "type": "integer"
          }
        }
      }
    }
  }
}

object AutotaskUpdateConfigurationResponse

{
  "type": "object",
  "properties": {}
}

string BillingGetContractResponse

{
  "type": "string",
  "format": "binary"
}

object 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"
}

array BulkUserExpiresRequest

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/bulk-user-expire"
  }
}

object BulkUserStatesCreate400Response

{
  "type": "object",
  "properties": {}
}

object BulkUserStatesCreate401Response

{
  "type": "object",
  "properties": {}
}

object BulkUserStatesCreate500Response

{
  "type": "object",
  "properties": {}
}

array BulkUserStatesCreateResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/scheduled-userstate-result"
  }
}

object 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."
    }
  }
}

array BulkUserStatesListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/scheduled-userstate-result"
  }
}

array BulkUserUnlocksRequest

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/bulk-user-unlock"
  }
}

array BulkUsersCreateRequest

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/bulk-user-create"
  }
}

array BulkUsersCreateResultsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/job-workresult"
  }
}

array BulkUsersUpdateRequest

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/bulk-user-update"
  }
}

object 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)"
}

object 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"
}

object 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)"
}

object ConfiguredPolicyTemplate

{
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "values": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConfiguredPolicyTemplateValue"
      }
    },
    "policyTemplateId": {
      "type": "string"
    }
  }
}

object 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."
    }
  }
}

object 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"
}

object 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"
}

object 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"
}

object 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"
}

object 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"
    }
  }
}

object ConnectWiseTicketingAlertConfigurationList

{
  "type": "object",
  "required": [
    "records"
  ],
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "alertId": {
                "type": "string"
              }
            }
          },
          {
            "$ref": "#/components/schemas/ConnectWiseTicketingAlertConfiguration"
          }
        ]
      }
    }
  }
}

object ConnectWiseTicketingAlertConfigurationOption

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "values": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string"
          },
          "value": {
            "type": "integer"
          }
        }
      }
    }
  }
}

object ConnectWiseTicketingAlertConfigurationOptions

{
  "type": "object",
  "required": [
    "records"
  ],
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConnectWiseTicketingAlertConfigurationOption"
      }
    }
  }
}

object 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"
    }
  }
}

object 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"
}

object 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"
}

object 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"
}

object ConnectwiseCompanyResp

{
  "type": "object",
  "required": [
    "totalCount",
    "records"
  ],
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConnectwiseCompany"
      }
    },
    "totalCount": {
      "type": "integer"
    }
  },
  "description": "Response for retrieving ConnectWise companies"
}

object 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"
}

object ConnectwiseCreateConfiguration422Response

{
  "type": "object",
  "properties": {}
}

object ConnectwiseCreateConfigurationResponse

{
  "type": "object",
  "required": [
    "integrationId"
  ],
  "properties": {
    "integrationId": {
      "type": "string",
      "description": "The identifier of the created integration"
    }
  }
}

object 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"
}

object 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"
}

object 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"
}

object ConnectwiseRetrieveAdditionsResponse

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConnectwiseAddition"
      }
    },
    "totalCount": {
      "type": "integer"
    }
  }
}

object ConnectwiseRetrieveAgreementsResponse

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConnectwiseAgreement"
      }
    },
    "totalCount": {
      "type": "integer"
    }
  }
}

object ConnectwiseRetrieveMappingsResponse

{
  "type": "object",
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConnectWiseMappingResponse"
      }
    },
    "totalCount": {
      "type": "number"
    }
  }
}

object ConnectwiseUpdateConfigurationResponse

{
  "type": "object",
  "properties": {}
}

object 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."
    }
  }
}

object 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."
}

object 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"
    }
  }
}

object CustomEmailTemplateField

{
  "type": "object",
  "title": "CustomEmailTemplateField",
  "properties": {
    "field": {
      "type": "string"
    },
    "multiline": {
      "type": "boolean"
    },
    "displayName": {
      "type": "string"
    },
    "defaultValue": {
      "type": "string"
    }
  }
}

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

array CustomEmailsGetTemplatesResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/CustomEmailTemplate"
  }
}

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

object DEPSetupAssistantOption

{
  "type": "object",
  "title": "DEP Setup Assistant Option",
  "properties": {
    "option": {
      "$ref": "#/components/schemas/SetupAssistantOption"
    }
  }
}

object 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."
    }
  }
}

object DevicesEraseDeviceRequest

{
  "type": "object"
}

object DevicesEraseDeviceResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object DevicesLockDeviceResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object DevicesRebootDeviceResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object DevicesResetPasswordRequest

{
  "type": "object",
  "properties": {
    "flags": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "newPassword": {
      "type": "string",
      "description": "Not logging as it contains sensitive information."
    }
  }
}

object DevicesResetPasswordResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

array DirectoriesListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Directory"
  }
}

object 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": ""
}

object DomainsInsertRequest

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    }
  }
}

object DuoAccount

{
  "type": "object",
  "title": "DuoAccount",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "object ID"
    },
    "name": {
      "type": "string",
      "description": "Duo application name."
    }
  }
}

array DuoAccountListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DuoAccount"
  }
}

object DuoApplication

{
  "type": "object",
  "title": "DuoApplication",
  "required": [
    "id",
    "name",
    "apiHost",
    "integrationKey"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "apiHost": {
      "type": "string"
    },
    "integrationKey": {
      "type": "string"
    }
  }
}

array DuoApplicationListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DuoApplication"
  }
}

object DuoApplicationReq

{
  "type": "object",
  "title": "DuoApplicationReq",
  "required": [
    "name",
    "apiHost",
    "integrationKey",
    "secretKey"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "apiHost": {
      "type": "string"
    },
    "secretKey": {
      "type": "string"
    },
    "integrationKey": {
      "type": "string"
    }
  }
}

object DuoApplicationUpdateReq

{
  "type": "object",
  "title": "DuoApplicationUpdateReq",
  "required": [
    "name",
    "apiHost",
    "integrationKey"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "apiHost": {
      "type": "string"
    },
    "secretKey": {
      "type": "string"
    },
    "integrationKey": {
      "type": "string"
    }
  }
}

object 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"
    }
  }
}

string EnrollmentsDownloadConfigFilesResponse

{
  "type": "string",
  "format": "binary"
}

object EnterprisesDeleteEnterpriseResponse

{
  "type": "object",
  "properties": {}
}

object EnterprisesPatchEnterpriseRequest

{
  "type": "object",
  "properties": {
    "deviceGroupId": {
      "type": "string",
      "format": "byte"
    },
    "allowDeviceEnrollment": {
      "type": "boolean"
    }
  }
}

object 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": ""
}

object 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"
        }
      }
    }
  ]
}

object FeatureTrialData

{
  "type": "object",
  "title": "FeatureTrials",
  "properties": {
    "endDate": {
      "type": "string"
    },
    "startDate": {
      "type": "string"
    }
  },
  "description": "Feature usage data for a feature"
}

string 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"
}

object GSuiteDeleteScheduledJob204Response

{
  "type": "object",
  "example": {},
  "properties": {}
}

object GSuiteDeleteScheduledJobResponse

{
  "type": "object",
  "properties": {}
}

string 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"
}

object 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"
    }
  }
}

object 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"
    }
  }
}

array GraphActiveDirectoryAssociationsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphConnection"
  }
}

array GraphActiveDirectoryTraverseUserGroupResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphActiveDirectoryTraverseUserResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphApplicationAssociationsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphConnection"
  }
}

array GraphApplicationTraverseUserGroupResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphApplicationTraverseUserResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

object 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."
}

object 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."
}

object 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."
}

object 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"
}

object 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"
}

object GraphAttributes

{
  "type": "object",
  "title": "GraphAttributes",
  "description": "The graph attributes.",
  "additionalProperties": true
}

array GraphCommandAssociationsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphConnection"
  }
}

array GraphCommandTraverseSystemGroupResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphCommandTraverseSystemResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

object 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."
}

array GraphGSuiteAssociationsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphConnection"
  }
}

array GraphGSuiteTraverseUserGroupResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphGSuiteTraverseUserResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphIdpRoutingPolicyAssociationsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphConnection"
  }
}

array GraphIdpRoutingPolicyTraverseUserGroupResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphIdpRoutingPolicyTraverseUserResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphLdapServerAssociationsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphConnection"
  }
}

array GraphLdapServerTraverseUserGroupResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphLdapServerTraverseUserResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

array GraphOffice365AssociationsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphConnection"
  }
}

array GraphOffice365TraverseUserGroupResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphOffice365TraverseUserResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

object 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."
    }
  }
}

object 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)"
}

object 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)"
}

object 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)"
}

object 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)"
}

object 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)"
}

object 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)"
}

object 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)"
}

object 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)"
}

object 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)"
}

object 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)"
}

object 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)"
}

object 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)"
}

object 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)"
}

object 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)"
}

object 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)"
}

object 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)"
}

object 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)"
}

object 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)"
}

array GraphPolicyAssociationsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphConnection"
  }
}

array GraphPolicyGroupAssociationsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphConnection"
  }
}

array GraphPolicyGroupMembersListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphConnection"
  }
}

array GraphPolicyGroupMembershipResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphPolicyGroupTraverseSystemGroupResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphPolicyGroupTraverseSystemResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphPolicyMemberOfResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphPolicyTraverseSystemGroupResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphPolicyTraverseSystemResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphRadiusServerAssociationsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphConnection"
  }
}

array GraphRadiusServerTraverseUserGroupResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphRadiusServerTraverseUserResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphSoftwareappsAssociationsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphConnection"
  }
}

array GraphSoftwareappsTraverseSystemGroupResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphSoftwareappsTraverseSystemResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphSystemAssociationsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphConnection"
  }
}

array GraphSystemGroupAssociationsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphConnection"
  }
}

array GraphSystemGroupMembersListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphConnection"
  }
}

array GraphSystemGroupMembershipResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphSystemGroupTraverseCommandResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/commandsGraphObjectWithPaths"
  }
}

array GraphSystemGroupTraversePolicyGroupResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphSystemGroupTraversePolicyResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphSystemGroupTraverseUserGroupResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphSystemGroupTraverseUserResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphSystemMemberOfResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphSystemTraverseCommandResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/commandsGraphObjectWithPaths"
  }
}

array GraphSystemTraversePolicyGroupResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphSystemTraversePolicyResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphSystemTraverseUserGroupResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphSystemTraverseUserResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

string 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."
}

array GraphUserAssociationsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphConnection"
  }
}

array GraphUserGroupAssociationsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphConnection"
  }
}

array GraphUserGroupMembersListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphConnection"
  }
}

array GraphUserGroupMembershipResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphUserGroupTraverseActiveDirectoryResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphUserGroupTraverseApplicationResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphUserGroupTraverseDirectoryResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphUserGroupTraverseGSuiteResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphUserGroupTraverseLdapServerResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphUserGroupTraverseOffice365Response

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphUserGroupTraverseRadiusServerResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphUserGroupTraverseSystemGroupResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphUserGroupTraverseSystemResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphUserMemberOfResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphUserTraverseActiveDirectoryResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphUserTraverseApplicationResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphUserTraverseDirectoryResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphUserTraverseGSuiteResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphUserTraverseLdapServerResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphUserTraverseOffice365Response

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphUserTraverseRadiusServerResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphUserTraverseSystemGroupResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

array GraphUserTraverseSystemResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphObjectWithPaths"
  }
}

object 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"
    }
  }
}

object 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."
}

string 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."
}

object 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"
    }
  }
}

string GroupType

{
  "enum": [
    "policy_group",
    "system_group",
    "user_group"
  ],
  "type": "string",
  "title": "GroupType",
  "description": "The group type."
}

array Groups

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "id",
      "name"
    ],
    "properties": {
      "id": {
        "type": "string",
        "format": "uuid"
      },
      "name": {
        "type": "string",
        "example": "group name"
      }
    }
  }
}

array GroupsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Group"
  }
}

object GsuitesListImportJumpcloudUsersResponse

{
  "type": "object",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/User"
      }
    },
    "nextPageToken": {
      "type": "string"
    }
  }
}

object 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"
    }
  }
}

object IPList

{
  "type": "object",
  "title": "IPList",
  "properties": {
    "id": {
      "type": "string"
    },
    "ips": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  }
}

object IPListRequest

{
  "type": "object",
  "title": "IPListRequest",
  "properties": {
    "ips": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  }
}

string ImportOperation

{
  "enum": [
    "users.create",
    "users.update"
  ],
  "type": "string",
  "title": "ImportOperation",
  "description": "The operation to be executed on import"
}

object 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"
    }
  }
}

string InstallActionType

{
  "enum": [
    "DOWNLOAD_ONLY",
    "INSTALL_LATER",
    "INSTALL_ASAP",
    "INSTALL_FORCE_RESTART"
  ],
  "type": "string"
}

object Integration

{
  "type": "object",
  "title": "Integration",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/IntegrationType"
    },
    "integrationId": {
      "type": "string",
      "description": "Unique identifier for this integration"
    }
  },
  "description": "An integration."
}

object 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"
}

object 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"
}

string IntegrationType

{
  "enum": [
    "autotask",
    "connectwise",
    "syncro"
  ],
  "type": "string",
  "title": "IntegrationType",
  "description": "The type of integration."
}

object IntegrationsResponse

{
  "type": "object",
  "title": "IntegrationsResponse",
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Integration"
      }
    },
    "totalCount": {
      "type": "integer"
    }
  },
  "description": "Response for retrieving integrations."
}

array IplistsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/IPList"
  }
}

object LdapGroup

{
  "type": "object",
  "title": "Ldap Group",
  "properties": {
    "name": {
      "type": "string"
    }
  },
  "description": "An LDAP group object."
}

string LdapServerAction

{
  "enum": [
    "disable",
    "remove"
  ],
  "type": "string",
  "title": "LDAP Server Action"
}

array LdapserversListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ldap-server"
  }
}

object LdapserversPatch400Response

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

object LdapserversPatchRequest

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "userLockoutAction": {
      "$ref": "#/components/schemas/LdapServerAction"
    },
    "userPasswordExpirationAction": {
      "$ref": "#/components/schemas/LdapServerAction"
    }
  }
}

object LdapserversPatchResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "userLockoutAction": {
      "$ref": "#/components/schemas/LdapServerAction"
    },
    "userPasswordExpirationAction": {
      "$ref": "#/components/schemas/LdapServerAction"
    }
  }
}

string LdapserversSambaDomainsDeleteResponse

{
  "type": "string"
}

array LdapserversSambaDomainsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/samba-domain"
  }
}

string LogosGet200Response

{
  "type": "string",
  "format": "binary"
}

string LogosGetResponse

{
  "type": "string",
  "format": "binary"
}

object 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."
}

object MemberSuggestion

{
  "properties": {
    "op": {
      "enum": [
        "add",
        "remove"
      ],
      "type": "string",
      "description": "How to modify group membership."
    },
    "object": {
      "$ref": "#/components/schemas/GraphObject"
    }
  }
}

object MemberSuggestionsPostResult

{
  "properties": {
    "suggestions_found": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "suggestions_not_found": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

object 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"
}

string 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"
}

string 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"
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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."
    }
  }
}

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

object PhoneNumber

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "maxLength": 1024
    },
    "number": {
      "type": "string",
      "maxLength": 1024
    }
  }
}

array PoliciesListAllPolicyResultsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/PolicyResult"
  }
}

array PoliciesListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Policy"
  }
}

object 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."
}

object 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."
}

object 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"
    }
  }
}

object PolicyGroupData

{
  "type": "object",
  "title": "PolicyGroupData",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Display name of a Policy Group."
    }
  }
}

object PolicyGroupTemplate

{
  "type": "object",
  "title": "PolicyGroupTemplate",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "members": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PolicyGroupTemplateMember"
      }
    },
    "description": {
      "type": "string"
    }
  }
}

object PolicyGroupTemplateMember

{
  "type": "object",
  "title": "PolicyGroupTemplateMember",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "policyTemplateId": {
      "type": "string"
    }
  }
}

object PolicyGroupTemplateMembers

{
  "type": "object",
  "title": "PolicyGroupTemplateMembers",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PolicyGroupTemplateMember"
      }
    },
    "totalCount": {
      "type": "integer"
    }
  }
}

object PolicyGroupTemplates

{
  "type": "object",
  "title": "PolicyGroupTemplates",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PolicyGroupTemplate"
      }
    },
    "totalCount": {
      "type": "integer"
    }
  }
}

object PolicyGroupTemplatesGetConfiguredPolicyTemplateResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object PolicyGroupTemplatesListConfiguredPolicyTemplatesResponse

{
  "type": "object",
  "properties": {
    "records": {
      "$ref": "#/components/schemas/ConfiguredPolicyTemplate"
    },
    "totalCount": {
      "type": "integer"
    }
  }
}

array PolicyGroupsListAllResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/PolicyGroup"
  }
}

object 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."
    }
  }
}

object 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."
}

object 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."
    }
  }
}

object 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."
}

object 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."
}

object 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."
    }
  }
}

object 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."
}

array PolicyresultsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/PolicyResult"
  }
}

array PolicystatusesPoliciesListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/PolicyResult"
  }
}

array PolicystatusesSystemsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/PolicyResult"
  }
}

array PolicytemplatesListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/PolicyTemplate"
  }
}

object Provider

{
  "example": {
    "id": "5c3536e9e0a6840001872799",
    "disallowOrgCreation": true
  },
  "properties": {
    "id": {
      "type": "string"
    },
    "disallowOrgCreation": {
      "type": "boolean"
    }
  }
}

object 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"
    }
  }
}

object 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"
}

object ProviderInvoiceResponse

{
  "type": "object",
  "title": "ProviderInvoiceResponse",
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ProviderInvoice"
      }
    },
    "totalCount": {
      "type": "integer"
    }
  },
  "description": "Response for retrieve provider invoices"
}

object ProvidersListAdministrators401Response

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

object ProvidersListAdministratorsResponse

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Administrator"
      }
    },
    "totalCount": {
      "type": "integer"
    }
  }
}

object ProvidersListOrganizationsResponse

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Organization"
      }
    },
    "totalCount": {
      "type": "integer"
    }
  }
}

object ProvidersPostAdminsResponse

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

string ProvidersRetrieveInvoiceResponse

{
  "type": "string",
  "format": "binary"
}

object 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."
}

array PushEndpointsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/PushEndpointResponse"
  }
}

object PushEndpointsPatchRequest

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "state": {
      "enum": [
        "active",
        "inactive"
      ],
      "type": "string"
    }
  }
}

object PushVerificationsStartRequest

{
  "type": "object",
  "title": "SendVerificationPushRequest represents a create request",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

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

object PwmCloudBackupRestores

{
  "type": "object",
  "properties": {
    "approved": {
      "type": "integer",
      "format": "int32"
    },
    "requested": {
      "type": "integer",
      "format": "int32"
    }
  }
}

object PwmItemHistory

{
  "type": "object",
  "properties": {
    "createdBy": {
      "type": "string",
      "format": "uuid"
    },
    "updatedBy": {
      "type": "string",
      "format": "uuid"
    },
    "dateCreated": {
      "type": "string"
    },
    "dateUpdated": {
      "type": "string"
    }
  }
}

object PwmItemsCountByType

{
  "type": "object",
  "properties": {
    "type": {
      "type": "integer",
      "format": "int32"
    },
    "count": {
      "type": "integer",
      "format": "int32"
    }
  }
}

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

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

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

object 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"
    }
  }
}

object PwmUserById

{
  "allOf": [
    {
      "$ref": "#/components/schemas/PwmUser"
    },
    {
      "$ref": "#/components/schemas/PasswordsSecurity"
    }
  ]
}

object 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"
    }
  }
}

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

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

object 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"
  }
}

object 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"
}

object 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"
    }
  }
}

string 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"
}

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

object 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"
          }
        }
      }
    }
  }
}

object SharedFolderDetails

{
  "allOf": [
    {
      "$ref": "#/components/schemas/SharedFolder"
    },
    {
      "$ref": "#/components/schemas/PasswordsSecurity"
    }
  ]
}

object SharedFolderGroups

{
  "type": "object",
  "required": [
    "results",
    "totalCount"
  ],
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GroupPwm"
      }
    },
    "totalCount": {
      "type": "integer",
      "format": "int32",
      "example": 50
    }
  }
}

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

object SharedFoldersList

{
  "type": "object",
  "required": [
    "results",
    "totalCount"
  ],
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SharedFolder"
      }
    },
    "totalCount": {
      "type": "integer",
      "format": "int32",
      "example": 50
    }
  }
}

array SoftwareAppStatusesListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/software-app-status"
  }
}

array SoftwareAppsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/software-app"
  }
}

object 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."
    }
  }
}

array SubscriptionsGetResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/subscription"
  }
}

object SuggestionCounts

{
  "type": "object",
  "readOnly": true,
  "properties": {
    "add": {
      "type": "integer"
    },
    "total": {
      "type": "integer"
    },
    "remove": {
      "type": "integer"
    }
  }
}

object 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)"
}

object 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)"
}

object SyncroBillingMappingConfigurationOptionValueLine

{
  "type": "object",
  "properties": {
    "label": {
      "type": "string"
    },
    "value": {
      "type": "integer"
    }
  },
  "description": "The shape of a Syncro billing mapping schedule's line"
}

object SyncroBillingMappingConfigurationOptionsResp

{
  "type": "object",
  "required": [
    "options"
  ],
  "properties": {
    "options": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SyncroBillingMappingConfigurationOption"
      }
    }
  },
  "description": "Response for retrieving Syncro billing mapping configuration options"
}

object 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"
}

object SyncroCompanyResp

{
  "type": "object",
  "required": [
    "totalCount",
    "records"
  ],
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SyncroCompany"
      }
    },
    "totalCount": {
      "type": "integer"
    }
  },
  "description": "Response for retrieving Syncro companies"
}

object SyncroCreateConfiguration422Response

{
  "type": "object",
  "properties": {}
}

object SyncroCreateConfigurationResponse

{
  "type": "object",
  "required": [
    "integrationId"
  ],
  "properties": {
    "integrationId": {
      "type": "string",
      "description": "The identifier of the created integration"
    }
  }
}

object 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"
}

object 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"
}

object 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"
}

object 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"
}

object 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"
}

object SyncroRetrieveMappingsResponse

{
  "type": "object",
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SyncroMappingResponse"
      }
    },
    "totalCount": {
      "type": "number"
    }
  }
}

object 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"
}

object 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"
}

object 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"
}

object SyncroTicketingAlertConfigurationList

{
  "type": "object",
  "required": [
    "records"
  ],
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "alertId": {
                "type": "string"
              }
            }
          },
          {
            "$ref": "#/components/schemas/SyncroTicketingAlertConfiguration"
          }
        ]
      }
    }
  }
}

object SyncroTicketingAlertConfigurationOption

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "values": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string"
          },
          "value": {
            "type": "integer"
          }
        }
      }
    }
  }
}

object SyncroTicketingAlertConfigurationOptions

{
  "type": "object",
  "required": [
    "records"
  ],
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SyncroTicketingAlertConfigurationOption"
      }
    }
  }
}

object 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."
}

object SyncroUpdateConfigurationResponse

{
  "type": "object",
  "properties": {}
}

object 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."
    }
  }
}

object 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."
    }
  }
}

object 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."
    }
  }
}

object SystemGroupsApplySuggestionsRequest

{
  "type": "object",
  "properties": {
    "object_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "x-examples": {
    "example-1": {
      "object_ids": [
        "212345678901234567890123",
        "123456789012345678901234"
      ]
    }
  }
}

object SystemGroupsApplySuggestionsResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

array SystemGroupsListAllResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/SystemGroup"
  }
}

array SystemGroupsListSuggestionsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/MemberSuggestion"
  }
}

string SystemInsightsGetChassisInfo400Response

{
  "type": "string"
}

array SystemInsightsGetChassisInfoResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-chassis-info"
  }
}

array SystemInsightsGetDiskInfoResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-disk-info"
  }
}

array SystemInsightsGetIeExtensionsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-ie-extensions"
  }
}

array SystemInsightsGetKernelInfoResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-kernel-info"
  }
}

array SystemInsightsGetOsVersionResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-os-version"
  }
}

array SystemInsightsGetSipConfigResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-sip-config"
  }
}

array SystemInsightsGetSystemInfoListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-system-info"
  }
}

string SystemInsightsGetTpmInfo400Response

{
  "type": "string"
}

array SystemInsightsGetTpmInfoResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-tpm-info"
  }
}

array SystemInsightsGetUserGroupsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-user-groups"
  }
}

array SystemInsightsListAlfExceptionsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-alf-exceptions"
  }
}

array SystemInsightsListAlfExplicitAuthsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-alf-explicit-auths"
  }
}

array SystemInsightsListAlfResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-alf"
  }
}

array SystemInsightsListAppcompatShimsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-appcompat-shims"
  }
}

array SystemInsightsListAppsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-apps"
  }
}

array SystemInsightsListAuthorizedKeysResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-authorized-keys"
  }
}

string SystemInsightsListAzureInstanceMetadata400Response

{
  "type": "string"
}

array SystemInsightsListAzureInstanceMetadataResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-azure-instance-metadata"
  }
}

string SystemInsightsListAzureInstanceTags400Response

{
  "type": "string"
}

array SystemInsightsListAzureInstanceTagsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-azure-instance-tags"
  }
}

array SystemInsightsListBatteryDataResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-battery"
  }
}

array SystemInsightsListBitlockerInfoResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-bitlocker-info"
  }
}

array SystemInsightsListBrowserPluginsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-browser-plugins"
  }
}

array SystemInsightsListCertificatesResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-certificates"
  }
}

array SystemInsightsListChromeExtensionsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-chrome-extensions"
  }
}

array SystemInsightsListConnectivityResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-connectivity"
  }
}

array SystemInsightsListCrashesResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-crashes"
  }
}

array SystemInsightsListCupsDestinationsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-cups-destinations"
  }
}

array SystemInsightsListDiskEncryptionResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-disk-encryption"
  }
}

array SystemInsightsListDnsResolversResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-dns-resolvers"
  }
}

array SystemInsightsListEtcHostsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-etc-hosts"
  }
}

array SystemInsightsListFirefoxAddonsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-firefox-addons"
  }
}

array SystemInsightsListGroupsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-groups"
  }
}

array SystemInsightsListInterfaceAddressesResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-interface-addresses"
  }
}

array SystemInsightsListInterfaceDetailsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-interface-details"
  }
}

array SystemInsightsListLaunchdResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-launchd"
  }
}

array SystemInsightsListLinuxPackagesResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-linux-packages"
  }
}

array SystemInsightsListLoggedInUsersResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-logged-in-users"
  }
}

array SystemInsightsListLogicalDrivesResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-logical-drives"
  }
}

array SystemInsightsListManagedPoliciesResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-managed-policies"
  }
}

array SystemInsightsListMountsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-mounts"
  }
}

array SystemInsightsListPatchesResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-patches"
  }
}

array SystemInsightsListProgramsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-programs"
  }
}

array SystemInsightsListPythonPackagesResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-python-packages"
  }
}

array SystemInsightsListSafariExtensionsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-safari-extensions"
  }
}

array SystemInsightsListScheduledTasksResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-scheduled-tasks"
  }
}

string SystemInsightsListSecureBoot400Response

{
  "type": "string"
}

array SystemInsightsListSecureBootResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-secureboot"
  }
}

array SystemInsightsListServicesResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-services"
  }
}

array SystemInsightsListShadowDataResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-shadow"
  }
}

array SystemInsightsListSharedFoldersResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-shared-folders"
  }
}

array SystemInsightsListSharedResourcesResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-shared-resources"
  }
}

array SystemInsightsListSharingPreferencesResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-sharing-preferences"
  }
}

array SystemInsightsListStartupItemsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-startup-items"
  }
}

array SystemInsightsListSystemControlsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-system-controls"
  }
}

array SystemInsightsListUptimeResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-uptime"
  }
}

array SystemInsightsListUsbDevicesResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-usb-devices"
  }
}

string SystemInsightsListUserAssist400Response

{
  "type": "string"
}

array SystemInsightsListUserAssistResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-userassist"
  }
}

array SystemInsightsListUserSshKeysResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-user-ssh-keys"
  }
}

array SystemInsightsListUsersResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-users"
  }
}

array SystemInsightsListWifiNetworksResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-wifi-networks"
  }
}

array SystemInsightsListWifiStatusResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-wifi-status"
  }
}

string SystemInsightsListWindowsSecurityCenter400Response

{
  "type": "string"
}

array SystemInsightsListWindowsSecurityCenterResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-windows-security-center"
  }
}

array SystemInsightsListWindowsSecurityProductsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/system-insights-windows-security-products"
  }
}

array SystemsListSoftwareAppsWithStatusesResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/software-app-with-status"
  }
}

object SystemsOrgSettingsSetDefaultPasswordSyncSettings204Response

{
  "type": "object",
  "example": {},
  "properties": {}
}

object SystemsOrgSettingsSetDefaultPasswordSyncSettingsResponse

{
  "type": "object",
  "properties": {}
}

object SystemsOrgSettingsSetSignInWithJumpCloudSettings204Response

{
  "type": "object",
  "example": {},
  "properties": {}
}

object SystemsOrgSettingsSetSignInWithJumpCloudSettingsResponse

{
  "type": "object",
  "properties": {}
}

object TicketingIntegrationAlert

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "category": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  }
}

object TicketingIntegrationAlertsResp

{
  "type": "object",
  "required": [
    "records"
  ],
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TicketingIntegrationAlert"
      }
    }
  }
}

array TranslationRulesGSuiteListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GSuiteTranslationRule"
  }
}

array TranslationRulesOffice365ListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Office365TranslationRule"
  }
}

object 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."
    }
  }
}

object 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."
    }
  }
}

object 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."
    }
  }
}

object 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."
    }
  }
}

object UserGroupsApplySuggestionsRequest

{
  "type": "object",
  "properties": {
    "user_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "x-examples": {
    "example-1": {
      "user_ids": [
        "212345678901234567890123",
        "123456789012345678901234"
      ]
    }
  }
}

object UserGroupsApplySuggestionsResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

array UserGroupsGetSuggestionsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/MemberSuggestion"
  }
}

array UserGroupsListAllResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/UserGroup"
  }
}

array WorkdaysImportresultsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/job-workresult"
  }
}

array WorkdaysListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/workday-output"
  }
}

array WorkdaysWorkersResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/workday-worker"
  }
}

object 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."
    }
  }
}

object active-directory-agent

{
  "type": "object",
  "title": "Active Directory Agent",
  "properties": {
    "agentType": {
      "enum": [
        "SYNC",
        "IMPORT"
      ],
      "type": "string"
    }
  }
}

object 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."
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
}

object 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"
}

object 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."
    }
  }
}

string apple-mdm-public-key-cert

{
  "type": "string",
  "title": "Apple MDM Public Key Certificate"
}

string apple-mdm-signed-csr-plist

{
  "type": "string",
  "title": "Apple MDM Signed CSR PList"
}

object auth-info

{
  "type": "object",
  "title": "Auth Info",
  "properties": {
    "expiry": {
      "type": "string"
    },
    "isValid": {
      "type": "boolean"
    },
    "message": {
      "type": "string"
    }
  }
}

object 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"
        }
      }
    }
  }
}

object 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"
    }
  }
}

object 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"
}

object 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."
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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."
}

object 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"
    }
  }
}

object defaultDomain

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "domain": {
      "type": "string",
      "readOnly": true
    }
  }
}

object 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"
    }
  }
}

object device_package.v1.ListDevicesResponse

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/device_package.v1.Device"
      }
    },
    "totalCount": {
      "type": "integer",
      "format": "int32"
    }
  }
}

object 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."
    }
  }
}

object devices.AggregatedPolicyResultResponse

{
  "type": "object",
  "properties": {
    "failedPolicies": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "pendingPolicies": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "policyCountData": {
      "$ref": "#/components/schemas/devices.AggregatedPolicyCount"
    }
  }
}

object devices.GetDefaultPasswordSyncSettingsResponse

{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    }
  }
}

object devices.GetSignInWithJumpCloudSettingsResponse

{
  "type": "object",
  "properties": {
    "settings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/devices.SignInWithJumpCloudSetting"
      }
    },
    "organizationObjectId": {
      "type": "string",
      "format": "byte"
    }
  }
}

object devices.SetDefaultPasswordSyncSettingsRequest

{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "organizationObjectId": {
      "type": "string",
      "format": "byte"
    }
  }
}

object devices.SetSignInWithJumpCloudSettingsRequest

{
  "type": "object",
  "properties": {
    "settings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/devices.SignInWithJumpCloudSetting"
      }
    },
    "organizationObjectId": {
      "type": "string",
      "format": "byte"
    }
  }
}

object devices.SignInWithJumpCloudSetting

{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "osFamily": {
      "$ref": "#/components/schemas/devices.SignInWithJumpCloudSetting.OSFamily"
    },
    "defaultPermission": {
      "$ref": "#/components/schemas/devices.SignInWithJumpCloudSetting.Permission"
    }
  }
}

string devices.SignInWithJumpCloudSetting.OSFamily

{
  "enum": [
    "UNKNOWN",
    "WINDOWS",
    "MACOS"
  ],
  "type": "string",
  "default": "UNKNOWN"
}

string devices.SignInWithJumpCloudSetting.Permission

{
  "enum": [
    "STANDARD",
    "ADMIN"
  ],
  "type": "string",
  "default": "STANDARD"
}

object 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."
}

object 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": {}
}

object google.rpc.Status

{
  "type": "object",
  "properties": {
    "code": {
      "type": "integer",
      "format": "int32"
    },
    "details": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/google.protobuf.Any"
      }
    },
    "message": {
      "type": "string"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object importUserPhoneNumber

{
  "type": "object",
  "title": "Import User Address",
  "properties": {
    "type": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  }
}

object importUsersResponse

{
  "type": "object",
  "title": "Import Users Response",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/importUser"
      }
    },
    "total_count": {
      "type": "number"
    }
  }
}

object job-id

{
  "type": "object",
  "title": "Job ID",
  "properties": {
    "jobId": {
      "type": "string"
    }
  },
  "x-examples": {
    "example-1": {
      "jobId": "string"
    }
  }
}

object 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"
    }
  }
}

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

string jumpcloud.auth.PushVerification.Status

{
  "enum": [
    "SENT",
    "ACCEPTED",
    "EXPIRED",
    "DENIED",
    "ERRORED"
  ],
  "type": "string",
  "default": "SENT"
}

object jumpcloud.gapps.CreateScheduledResponse

{
  "type": "object",
  "properties": {
    "scheduledJobId": {
      "type": "string",
      "format": "hex",
      "description": "ObjectID of the created Scheduled Job"
    }
  }
}

object 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."
    }
  }
}

object jumpcloud.gapps.DomainListResponse

{
  "type": "object",
  "properties": {
    "domains": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jumpcloud.gapps.Domain"
      }
    },
    "totalCount": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object jumpcloud.gapps.DomainResponse

{
  "type": "object",
  "properties": {
    "domain": {
      "$ref": "#/components/schemas/jumpcloud.gapps.Domain"
    }
  }
}

object jumpcloud.gapps.ListScheduledResponse

{
  "type": "object",
  "properties": {
    "schedules": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jumpcloud.gapps.ScheduledImport"
      }
    }
  }
}

object jumpcloud.gapps.ScheduledImport

{
  "type": "object",
  "properties": {
    "scheduledJobId": {
      "type": "string",
      "format": "hex",
      "description": "ObjectID of the Scheduled Job"
    }
  }
}

string 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"
}

object jumpcloud.google_emm.CommandResponse

{
  "type": "object"
}

object jumpcloud.google_emm.CommonCriteriaModeInfo

{
  "type": "object",
  "properties": {
    "commonCriteriaModeStatus": {
      "type": "string"
    }
  }
}

object jumpcloud.google_emm.ConnectionStatus

{
  "type": "object",
  "properties": {
    "isConnected": {
      "type": "boolean"
    },
    "enterpriseId": {
      "type": "string",
      "format": "byte"
    },
    "organizationObjectId": {
      "type": "string",
      "format": "byte"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object jumpcloud.google_emm.CreateWebTokenRequest

{
  "type": "object",
  "properties": {
    "iframeFeature": {
      "$ref": "#/components/schemas/jumpcloud.google_emm.Feature"
    },
    "parentFrameUrl": {
      "type": "string"
    },
    "enterpriseObjectId": {
      "type": "string",
      "format": "byte"
    }
  }
}

string jumpcloud.google_emm.CreatedWhere

{
  "enum": [
    "API",
    "ADMIN_PORTAL",
    "USER_PORTAL"
  ],
  "type": "string",
  "title": "Identifies where create enrollment token request originated",
  "default": "API"
}

object jumpcloud.google_emm.DeleteEnrollmentTokenResponse

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    }
  }
}

object jumpcloud.google_emm.Device

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "deviceId": {
      "type": "string",
      "format": "byte"
    },
    "deviceInformation": {
      "$ref": "#/components/schemas/jumpcloud.google_emm.DeviceInformation"
    }
  }
}

object jumpcloud.google_emm.DeviceAndroidPolicy

{
  "type": "object",
  "properties": {
    "policy": {
      "type": "string"
    }
  }
}

object jumpcloud.google_emm.DeviceData

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "deviceId": {
      "type": "string",
      "format": "byte"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

string jumpcloud.google_emm.EnrollmentType

{
  "enum": [
    "WORK_PROFILE",
    "FULLY_MANAGED",
    "DEDICATED",
    "BYOD",
    "COPE"
  ],
  "type": "string",
  "title": "Identifies how device enrolled",
  "default": "WORK_PROFILE"
}

object 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"
    }
  }
}

string jumpcloud.google_emm.Feature

{
  "enum": [
    "SOFTWARE_MANAGEMENT",
    "ZERO_TOUCH_CUSTOMER_MANAGEMENT"
  ],
  "type": "string",
  "default": "SOFTWARE_MANAGEMENT"
}

object 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"
    }
  }
}

object jumpcloud.google_emm.ListDevicesResponse

{
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "format": "int64"
    },
    "devices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jumpcloud.google_emm.DeviceData"
      }
    }
  }
}

object jumpcloud.google_emm.ListEnrollmentTokensResponse

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jumpcloud.google_emm.EnrollmentToken"
      }
    },
    "totalCount": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object jumpcloud.google_emm.ListEnterprisesResponse

{
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "format": "int64"
    },
    "enterprises": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jumpcloud.google_emm.Enterprise"
      }
    }
  }
}

object jumpcloud.google_emm.MemoryInfo

{
  "type": "object",
  "properties": {
    "totalRam": {
      "type": "integer",
      "format": "int64"
    },
    "totalInternalStorage": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object 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."
    }
  }
}

object jumpcloud.google_emm.ProvisioningExtras

{
  "type": "object",
  "properties": {
    "wifiSsid": {
      "type": "string"
    },
    "wifiPassword": {
      "type": "string"
    },
    "wifiSecurityType": {
      "$ref": "#/components/schemas/jumpcloud.google_emm.WifiSecurityType"
    },
    "wifiHiddenNetwork": {
      "type": "boolean"
    }
  }
}

object jumpcloud.google_emm.SecurityPosture

{
  "type": "object",
  "properties": {
    "devicePosture": {
      "type": "string"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object jumpcloud.google_emm.SystemUpdateInfo

{
  "type": "object",
  "properties": {
    "updateStatus": {
      "type": "string"
    },
    "updateReceivedTime": {
      "type": "string"
    }
  }
}

object 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."
    }
  }
}

object jumpcloud.google_emm.WebToken

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  }
}

string jumpcloud.google_emm.WifiSecurityType

{
  "enum": [
    "NONE",
    "WPA",
    "WEP"
  ],
  "type": "string",
  "default": "NONE"
}

object 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"
    }
  }
}

object jumpcloud.ingresso.CreateAccessRequestsResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

object 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"
    }
  }
}

object jumpcloud.ingresso.RevokeAccessRequestsResponse

{
  "type": "object"
}

object jumpcloud.ingresso.UpdateAccessRequestsResponse

{
  "type": "object"
}

object jumpcloud.microsoft_mdm.DownloadConfigFilesRequest

{
  "type": "object"
}

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

object 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"
    }
  }
}

object 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"
      }
    }
  }
}

object jumpcloud.package_validator.ValidateApplicationInstallPackageRequest

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string"
    }
  }
}

object jumpcloud.package_validator.ValidateApplicationInstallPackageResponse

{
  "type": "object",
  "properties": {
    "applePackageDetails": {
      "$ref": "#/components/schemas/jumpcloud.package_validator.ApplePackageDetails"
    }
  }
}

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

string mobileconfig

{
  "type": "string",
  "title": "mobileconfig"
}

object 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."
    }
  }
}

object o365.DomainResponse

{
  "type": "object",
  "properties": {
    "domain": {
      "$ref": "#/components/schemas/o365.Domain"
    }
  }
}

object o365.DomainsListResponse

{
  "type": "object",
  "properties": {
    "domains": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/o365.Domain"
      }
    },
    "totalCount": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object 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 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."
}

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

object 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"
    }
  }
}

object 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."
    }
  }
}

object 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"
    }
  }
}

object 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'."
}

object 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"
    }
  }
}

object 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'."
}

object 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'."
}

object 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."
    }
  }
}

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

object 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"
    }
  }
}

object 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"
    }
  }
}

object software-app-with-status

{
  "title": "SoftwareAppsWithStatus",
  "properties": {
    "app": {
      "$ref": "#/components/schemas/software-app"
    },
    "status": {
      "$ref": "#/components/schemas/software-app-status"
    }
  }
}

object 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."
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object system-insights-cups-destinations

{
  "properties": {
    "name": {
      "type": "string"
    },
    "system_id": {
      "type": "string"
    },
    "option_name": {
      "type": "string"
    },
    "option_value": {
      "type": "string"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object systemfdekey

{
  "type": "object",
  "title": "SystemFDEKey",
  "required": [
    "key"
  ],
  "properties": {
    "key": {
      "type": "string"
    }
  }
}

object workday-fields

{
  "type": "object",
  "title": "Workday Fields",
  "properties": {
    "name": {
      "type": "string"
    },
    "reportUrl": {
      "type": "string"
    }
  }
}

object 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"
    }
  }
}

object 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"
    }
  }
}

object workday-worker

{
  "type": "object",
  "title": "Workday Worker",
  "properties": {
    "email": {
      "type": "string"
    },
    "lastName": {
      "type": "string"
    },
    "username": {
      "type": "string"
    },
    "firstName": {
      "type": "string"
    },
    "attributes": {
      "type": "object"
    }
  }
}