SystemInsightsListServicesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-services"
}
}
SystemInsightsListShadowDataResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-shadow"
}
}
SystemInsightsListSharedFoldersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-shared-folders"
}
}
SystemInsightsListSharedResourcesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-shared-resources"
}
}
SystemInsightsListSharingPreferencesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-sharing-preferences"
}
}
SystemInsightsListStartupItemsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-startup-items"
}
}
SystemInsightsListSystemControlsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-system-controls"
}
}
SystemInsightsListUptimeResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-uptime"
}
}
SystemInsightsListUsbDevicesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-usb-devices"
}
}
SystemInsightsListUserAssist400Response
{
"type": "string"
}
SystemInsightsListUserAssistResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-userassist"
}
}
SystemInsightsListUserSshKeysResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-user-ssh-keys"
}
}
SystemInsightsListUsersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-users"
}
}
SystemInsightsListWifiNetworksResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-wifi-networks"
}
}
SystemInsightsListWifiStatusResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-wifi-status"
}
}
SystemInsightsListWindowsSecurityCenter400Response
{
"type": "string"
}
SystemInsightsListWindowsSecurityCenterResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-windows-security-center"
}
}
SystemInsightsListWindowsSecurityProductsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/system-insights-windows-security-products"
}
}
SystemsListSoftwareAppsWithStatusesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/software-app-with-status"
}
}
SystemsOrgSettingsSetDefaultPasswordSyncSettings204Response
{
"type": "object",
"example": {},
"properties": {}
}
SystemsOrgSettingsSetDefaultPasswordSyncSettingsResponse
{
"type": "object",
"properties": {}
}
SystemsOrgSettingsSetSignInWithJumpCloudSettings204Response
{
"type": "object",
"example": {},
"properties": {}
}
SystemsOrgSettingsSetSignInWithJumpCloudSettingsResponse
{
"type": "object",
"properties": {}
}
TicketingIntegrationAlert
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"category": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
TicketingIntegrationAlertsResp
{
"type": "object",
"required": [
"records"
],
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TicketingIntegrationAlert"
}
}
}
}
TranslationRulesGSuiteListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GSuiteTranslationRule"
}
}
TranslationRulesOffice365ListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Office365TranslationRule"
}
}
User
{
"type": "object",
"title": "User",
"properties": {
"email": {
"type": "string",
"maxLength": 1024
},
"company": {
"type": "string",
"maxLength": 1024
},
"jobTitle": {
"type": "string",
"maxLength": 1024
},
"lastname": {
"type": "string",
"maxLength": 1024
},
"location": {
"type": "string",
"maxLength": 1024
},
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Address"
}
},
"firstname": {
"type": "string",
"maxLength": 1024
},
"costCenter": {
"type": "string",
"maxLength": 1024
},
"department": {
"type": "string",
"maxLength": 1024
},
"employeeType": {
"type": "string",
"maxLength": 1024
},
"phoneNumbers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PhoneNumber"
}
},
"alternateEmail": {
"type": "string"
},
"employeeIdentifier": {
"type": "string",
"maxLength": 256,
"description": "Must be unique per user."
}
}
}
UserGroup
{
"type": "object",
"title": "UserGroup",
"properties": {
"id": {
"type": "string",
"description": "ObjectId uniquely identifying a User Group."
},
"name": {
"type": "string",
"description": "Display name of a User Group."
},
"type": {
"enum": [
"user_group"
],
"type": "string",
"description": "The type of the group."
},
"email": {
"type": "string",
"description": "Email address of a User Group"
},
"attributes": {
"$ref": "#/components/schemas/GroupAttributes-UserGroup"
},
"description": {
"type": "string",
"description": "Description of a User Group"
},
"memberQuery": {
"$ref": "#/components/schemas/MemberQuery"
},
"membershipMethod": {
"$ref": "#/components/schemas/GroupMembershipMethodType"
},
"suggestionCounts": {
"$ref": "#/components/schemas/SuggestionCounts"
},
"memberQueryExemptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObject"
},
"description": "Array of GraphObjects exempted from the query"
},
"memberSuggestionsNotify": {
"type": "boolean",
"description": "True if notification emails are to be sent for membership suggestions."
}
}
}
UserGroupPost
{
"type": "object",
"title": "UserGroupPost",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Display name of a User Group."
},
"email": {
"type": "string",
"description": "Email address of a User Group"
},
"attributes": {
"$ref": "#/components/schemas/GroupAttributes-UserGroup"
},
"description": {
"type": "string",
"description": "Description of a User Group"
},
"memberQuery": {
"$ref": "#/components/schemas/MemberQuery"
},
"membershipMethod": {
"$ref": "#/components/schemas/GroupMembershipMethodType"
},
"memberQueryExemptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObject"
},
"description": "Array of GraphObjects exempted from the query"
},
"memberSuggestionsNotify": {
"type": "boolean",
"description": "True if notification emails are to be sent for membership suggestions."
}
}
}
UserGroupPut
{
"type": "object",
"title": "UserGroupPut",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Display name of a User Group."
},
"email": {
"type": "string",
"description": "Email address of a User Group"
},
"attributes": {
"$ref": "#/components/schemas/GroupAttributes-UserGroup"
},
"description": {
"type": "string",
"description": "Description of a User Group"
},
"memberQuery": {
"$ref": "#/components/schemas/MemberQuery"
},
"membershipMethod": {
"$ref": "#/components/schemas/GroupMembershipMethodType"
},
"memberQueryExemptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphObject"
},
"description": "Array of GraphObjects exempted from the query"
},
"memberSuggestionsNotify": {
"type": "boolean",
"description": "True if notification emails are to be sent for membership suggestions."
}
}
}
UserGroupsApplySuggestionsRequest
{
"type": "object",
"properties": {
"user_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-examples": {
"example-1": {
"user_ids": [
"212345678901234567890123",
"123456789012345678901234"
]
}
}
}
UserGroupsApplySuggestionsResponse
{
"type": "object",
"example": {},
"properties": {}
}
UserGroupsGetSuggestionsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberSuggestion"
}
}
UserGroupsListAllResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/UserGroup"
}
}
WorkdaysImportresultsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/job-workresult"
}
}
WorkdaysListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/workday-output"
}
}
WorkdaysWorkersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/workday-worker"
}
}
active-directory
{
"type": "object",
"title": "Active Directory",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "ObjectID of this Active Directory instance."
},
"domain": {
"type": "string",
"description": "Domain name for this Active Directory instance."
},
"useCase": {
"enum": [
"UNSET",
"TWOWAYSYNC",
"JCASAUTHORITY",
"ADASAUTHORITY"
],
"type": "string"
},
"primaryAgent": {
"type": "string",
"readOnly": true,
"description": "ObjectID of the primary agent of domain."
}
}
}
active-directory-agent
{
"type": "object",
"title": "Active Directory Agent",
"properties": {
"agentType": {
"enum": [
"SYNC",
"IMPORT"
],
"type": "string"
}
}
}
active-directory-agent-get
{
"type": "object",
"title": "Active Directory Agent Get",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "ObjectID of this Active Directory Agent."
},
"state": {
"enum": [
"unsealed",
"active",
"inactive"
],
"type": "string"
},
"version": {
"type": "string"
},
"hostname": {
"type": "string"
},
"contactAt": {
"type": "string"
},
"source_ip": {
"type": "string"
},
"connectKey": {
"type": "string",
"description": "The connect key to use when installing the Agent on a Domain Controller."
}
}
}
active-directory-agent-list
{
"type": "object",
"title": "Active Directory Agent List",
"properties": {
"id": {
"type": "string",
"description": "ObjectID of this Active Directory Agent."
},
"state": {
"enum": [
"unsealed",
"active",
"inactive"
],
"type": "string"
},
"version": {
"type": "string"
},
"hostname": {
"type": "string"
},
"contactAt": {
"type": "string"
},
"source_ip": {
"type": "string"
}
}
}
apple-mdm-device
{
"type": "object",
"title": "Apple MDM Device",
"x-tags": [
"Apple MDM"
],
"properties": {
"id": {
"type": "string"
},
"udid": {
"type": "string"
},
"enrolled": {
"type": "boolean"
},
"createdAt": {
"type": "string"
},
"osVersion": {
"type": "string"
},
"securityInfo": {
"$ref": "#/components/schemas/apple-mdm-device-security-info"
},
"serialNumber": {
"type": "string"
},
"depRegistered": {
"type": "boolean"
},
"deviceInformation": {
"$ref": "#/components/schemas/apple-mdm-device-info"
},
"hasActivationLockBypassCodes": {
"type": "boolean"
}
}
}
apple-mdm-device-info
{
"type": "object",
"title": "Apple MDM Device Info",
"x-tags": [
"Apple MDM"
],
"properties": {
"imei": {
"type": "string"
},
"iccid": {
"type": "string"
},
"wifiMac": {
"type": "string"
},
"modelName": {
"type": "string"
},
"deviceName": {
"type": "string"
},
"secondImei": {
"type": "string"
},
"secondIccid": {
"type": "string"
},
"isSupervised": {
"type": "boolean"
},
"deviceCapacity": {
"type": "number"
},
"availableDeviceCapacity": {
"type": "number"
},
"subscriberCarrierNetwork": {
"type": "string"
},
"secondSubscriberCarrierNetwork": {
"type": "string"
},
"activationLockAllowedWhileSupervised": {
"type": "boolean"
}
},
"description": "Apple MDM device information"
}
apple-mdm-device-security-info
{
"type": "object",
"title": "Apple MDM Device Security Info",
"x-tags": [
"Apple MDM"
],
"properties": {
"enrolledViaDep": {
"type": "boolean"
},
"passcodePresent": {
"type": "boolean"
},
"isUserEnrollment": {
"type": "boolean"
},
"userApprovedEnrollment": {
"type": "boolean"
},
"isActivationLockManageable": {
"type": "boolean"
}
},
"description": "Apple MDM device security information"
}
apple-mdm-patch
{
"type": "object",
"title": "Apple MDM Patch",
"properties": {
"dep": {
"$ref": "#/components/schemas/DEP"
},
"ades": {
"$ref": "#/components/schemas/ADES"
},
"name": {
"type": "string",
"maxLength": 255,
"description": "A new name for the Apple MDM configuration."
},
"appleSignedCert": {
"type": "string",
"description": "A signed certificate obtained from Apple after providing Apple with the plist file provided on POST."
},
"defaultSystemGroupID": {
"type": "string",
"description": "ObjectId uniquely identifying the MDM default System Group."
},
"appleCertCreatorAppleID": {
"type": "string",
"description": "The Apple ID of the admin who created the Apple signed certificate."
},
"encryptedDepServerToken": {
"type": "string",
"description": "The S/MIME encoded DEP Server Token returned by Apple Business Manager when creating an MDM instance."
},
"allowMobileUserEnrollment": {
"type": "boolean",
"description": "A toggle to allow mobile device enrollment for an organization."
},
"defaultIosUserEnrollmentDeviceGroupID": {
"type": "string",
"description": "ObjectId uniquely identifying the MDM default iOS user enrollment device group."
}
}
}
apple-mdm-public-key-cert
{
"type": "string",
"title": "Apple MDM Public Key Certificate"
}
apple-mdm-signed-csr-plist
{
"type": "string",
"title": "Apple MDM Signed CSR PList"
}
auth-info
{
"type": "object",
"title": "Auth Info",
"properties": {
"expiry": {
"type": "string"
},
"isValid": {
"type": "boolean"
},
"message": {
"type": "string"
}
}
}
auth-input
{
"type": "object",
"title": "Auth Input",
"properties": {
"basic": {
"type": "object",
"properties": {
"password": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"oauth": {
"type": "object",
"properties": {
"code": {
"type": "string"
}
}
}
}
}