Skip to content
Developers
Get API KeyGet API Key(opens in a new tab)

Access Control Components

Create an access controlled door

Create an access controlled door

POST/api/component/createAccessControlledDoor

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the write scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

accessControlledDoorobjectbody
Show child attributes
ajarTimeSecinteger<int32> | nullbody
apbModeenum<string>body

Available options: HARD_STRICT, HARD_PERMISSIVE, SOFT, NONE

apbZoneIdstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

aperioDoorExtensionComponentobjectbody
Show child attributes
componentUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

aperioDoorIdstring | nullbody
aperioGatewayComponentobjectbody
Show child attributes
componentUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

associatedCamerasstring<DeviceFacetUuid>[] | nullbody
associatedFaceDetectionCamerasstring<DeviceFacetUuid>[] | nullbody
buttonComponentsobject[] | nullbody
Show child attributes
componentUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | nullbody
defaultAccessStateOriginatorobjectbody
Show child attributes
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

One of:

Show Support Authority variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

grantedToInternalEntityUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

grantedToNamestring | nullbody
supportAuthorityUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

supportUserEmailstring | nullbody
supportUsernamestring | nullbody
Show Api Token variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

tokenNamestring | nullbody
tokenUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show User variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

userEmailstring | nullbody
userUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

usernamestring | nullbody
Show Rule variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

ruleNamestring | nullbody
ruleUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Component Composite variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

componentCompositeNamestring | nullbody
componentCompositeUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

correlationIdstring | nullbody
eventUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

originatorobjectbody
Show Guest Pass variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

guestPassNamestring | nullbody
guestPassUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Device Service variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

serviceNamestring | nullbody
defaultAccessStateRequestedAtMillisinteger<int64> | nullbody
defaultStateenum<string>body

Available options: UNLOCKED, ACCESS_CONTROLLED

directionRadiansnumber<float> | nullbody
doorAuthFirstInStateOverrideobjectbody
Show child attributes
originatorobjectbody
Show child attributes
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

One of:

Show Support Authority variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

grantedToInternalEntityUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

grantedToNamestring | nullbody
supportAuthorityUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

supportUserEmailstring | nullbody
supportUsernamestring | nullbody
Show Api Token variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

tokenNamestring | nullbody
tokenUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show User variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

userEmailstring | nullbody
userUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

usernamestring | nullbody
Show Rule variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

ruleNamestring | nullbody
ruleUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Component Composite variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

componentCompositeNamestring | nullbody
componentCompositeUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

correlationIdstring | nullbody
eventUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

originatorobjectbody
Show Guest Pass variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

guestPassNamestring | nullbody
guestPassUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Device Service variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

serviceNamestring | nullbody
requestedAtMillisinteger<int64> | nullbody
stateenum<string>body

Available options: REQUIRED, SATISFIED

doorScheduleFirstInStateOverrideobjectbody
Show child attributes
originatorobjectbody
Show child attributes
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

One of:

Show Support Authority variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

grantedToInternalEntityUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

grantedToNamestring | nullbody
supportAuthorityUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

supportUserEmailstring | nullbody
supportUsernamestring | nullbody
Show Api Token variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

tokenNamestring | nullbody
tokenUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show User variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

userEmailstring | nullbody
userUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

usernamestring | nullbody
Show Rule variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

ruleNamestring | nullbody
ruleUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Component Composite variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

componentCompositeNamestring | nullbody
componentCompositeUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

correlationIdstring | nullbody
eventUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

originatorobjectbody
Show Guest Pass variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

guestPassNamestring | nullbody
guestPassUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Device Service variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

serviceNamestring | nullbody
requestedAtMillisinteger<int64> | nullbody
stateenum<string>body

Available options: REQUIRED, SATISFIED

doorStateOverrideobjectbody
Show child attributes
originatorobjectbody
Show child attributes
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

One of:

Show Support Authority variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

grantedToInternalEntityUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

grantedToNamestring | nullbody
supportAuthorityUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

supportUserEmailstring | nullbody
supportUsernamestring | nullbody
Show Api Token variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

tokenNamestring | nullbody
tokenUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show User variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

userEmailstring | nullbody
userUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

usernamestring | nullbody
Show Rule variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

ruleNamestring | nullbody
ruleUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Component Composite variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

componentCompositeNamestring | nullbody
componentCompositeUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

correlationIdstring | nullbody
eventUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

originatorobjectbody
Show Guest Pass variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

guestPassNamestring | nullbody
guestPassUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Device Service variant
auditPrincipalstring | nullbody
typeenum<string>body

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

serviceNamestring | nullbody
requestedAtMillisinteger<int64> | nullbody
typeenum<string>body

Available options: DOOR_STATE_OVERRIDE, CANCELLED_DOOR_STATE_OVERRIDE

doorStateToScheduleUuidMapobject | nullbody
dpiComponentsobject[] | nullbody
Show child attributes
componentUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

floorNumberinteger<int32> | nullbody
forceAllReadersFirstInAuthRequiredLedFeedbackEnabledboolean | nullbody
forceAllReadersFirstInUnlockPendingLedFeedbackEnabledboolean | nullbody
forceAllReadersOtherReaderUnlockAudioFeedbackEnabledboolean | nullbody
forceAllReadersRemoteUnlockAudioFeedbackEnabledboolean | nullbody
forcedOpenEnabledboolean | nullbody
forcedOpenTimeSecinteger<int32> | nullbody
geofenceEnabledboolean | nullbody
geofenceRadiusnumber<double> | nullbody
latitudenumber<double> | nullbody
locationUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

longitudenumber<double> | nullbody
namestring | nullbody
nfcSecureDowngradeEnabledboolean | nullbody
orgUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

policyUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

privacyModeSupportEnabledboolean | nullbody
proximityUnlockSettingsobjectbody
Show child attributes
credCooldownSecinteger<int32> | nullbody
enabledboolean | nullbody
exitResetsCooldownboolean | nullbody
holdUnlockedboolean | nullbody
holdUnlockedEventIntervalSecinteger<int32> | nullbody
maxHoldUnlockedTimeSecinteger<int32> | nullbody
minHoldUnlockedTimeSecinteger<int32> | nullbody
minRSSIThresholdinteger<int32> | nullbody
readerComponentsobject[] | nullbody
Show child attributes
componentUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

relayComponentsobject[] | nullbody
Show child attributes
componentUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

relockAfterOpenTimeMsinteger<int32> | nullbody
remoteUnlockEnabledboolean | nullbody
rexComponentsobject[] | nullbody
Show child attributes
componentUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

schlageDoorExtensionComponentobjectbody
Show child attributes
componentUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

schlageGatewayComponentobjectbody
Show child attributes
componentUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

schlageGatewayRs485Addressinteger<int32> | nullbody
schlageRs485Addressinteger<int32> | nullbody
sendExpiredIntentEventsboolean | nullbody
subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | nullbody

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

subTypeenum<string>body

Available options: RHOMBUS, APERIO, APERIO_RS485, SCHLAGE_R485

typeenum<string>body

Available options: AccessControlledDoor, AccessControlledElevator, AccessControlledElevatorLanding

unlockTimeSecinteger<int32> | nullbody
unlockTimeSecRexinteger<int32> | nullbody
updatedAtMillisinteger<int64> | nullbody
uuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

waveToUnlockSettingsobjectbody
Show child attributes
awaitAuthDurationMsinteger<int32> | nullbody
enabledboolean | nullbody
minRSSIThresholdinteger<int32> | nullbody
showAwaitIntentFeedbackboolean | nullbody
treatNfcAsIntentboolean | nullbody
accessControlledDoorLabelsstring[] | nullbody

Response

200 OK

application/json · object

accessControlledDoorobject
Show child attributes
ajarTimeSecinteger<int32> | null
apbModeenum<string>

Available options: HARD_STRICT, HARD_PERMISSIVE, SOFT, NONE

apbZoneIdstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

aperioDoorExtensionComponentobject
Show child attributes
componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

aperioDoorIdstring | null
aperioGatewayComponentobject
Show child attributes
componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

associatedCamerasstring<DeviceFacetUuid>[] | null
associatedFaceDetectionCamerasstring<DeviceFacetUuid>[] | null
buttonComponentsobject[] | null
Show child attributes
componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null
defaultAccessStateOriginatorobject
Show child attributes
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

One of:

Show Support Authority variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

grantedToInternalEntityUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

grantedToNamestring | null
supportAuthorityUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

supportUserEmailstring | null
supportUsernamestring | null
Show Api Token variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

tokenNamestring | null
tokenUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show User variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

userEmailstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

usernamestring | null
Show Rule variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

ruleNamestring | null
ruleUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Component Composite variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

componentCompositeNamestring | null
componentCompositeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

correlationIdstring | null
eventUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

originatorobject
Show Guest Pass variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

guestPassNamestring | null
guestPassUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Device Service variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

serviceNamestring | null
defaultAccessStateRequestedAtMillisinteger<int64> | null
defaultStateenum<string>

Available options: UNLOCKED, ACCESS_CONTROLLED

directionRadiansnumber<float> | null
doorAuthFirstInStateOverrideobject
Show child attributes
originatorobject
Show child attributes
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

One of:

Show Support Authority variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

grantedToInternalEntityUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

grantedToNamestring | null
supportAuthorityUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

supportUserEmailstring | null
supportUsernamestring | null
Show Api Token variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

tokenNamestring | null
tokenUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show User variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

userEmailstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

usernamestring | null
Show Rule variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

ruleNamestring | null
ruleUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Component Composite variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

componentCompositeNamestring | null
componentCompositeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

correlationIdstring | null
eventUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

originatorobject
Show Guest Pass variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

guestPassNamestring | null
guestPassUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Device Service variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

serviceNamestring | null
requestedAtMillisinteger<int64> | null
stateenum<string>

Available options: REQUIRED, SATISFIED

doorScheduleFirstInStateOverrideobject
Show child attributes
originatorobject
Show child attributes
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

One of:

Show Support Authority variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

grantedToInternalEntityUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

grantedToNamestring | null
supportAuthorityUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

supportUserEmailstring | null
supportUsernamestring | null
Show Api Token variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

tokenNamestring | null
tokenUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show User variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

userEmailstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

usernamestring | null
Show Rule variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

ruleNamestring | null
ruleUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Component Composite variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

componentCompositeNamestring | null
componentCompositeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

correlationIdstring | null
eventUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

originatorobject
Show Guest Pass variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

guestPassNamestring | null
guestPassUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Device Service variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

serviceNamestring | null
requestedAtMillisinteger<int64> | null
stateenum<string>

Available options: REQUIRED, SATISFIED

doorStateOverrideobject
Show child attributes
originatorobject
Show child attributes
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

One of:

Show Support Authority variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

grantedToInternalEntityUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

grantedToNamestring | null
supportAuthorityUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

supportUserEmailstring | null
supportUsernamestring | null
Show Api Token variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

tokenNamestring | null
tokenUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show User variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

userEmailstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

usernamestring | null
Show Rule variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

ruleNamestring | null
ruleUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Component Composite variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

componentCompositeNamestring | null
componentCompositeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

correlationIdstring | null
eventUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

originatorobject
Show Guest Pass variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

guestPassNamestring | null
guestPassUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Device Service variant
auditPrincipalstring | null
typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

serviceNamestring | null
requestedAtMillisinteger<int64> | null
typeenum<string>

Available options: DOOR_STATE_OVERRIDE, CANCELLED_DOOR_STATE_OVERRIDE

doorStateToScheduleUuidMapobject | null
dpiComponentsobject[] | null
Show child attributes
componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

floorNumberinteger<int32> | null
forceAllReadersFirstInAuthRequiredLedFeedbackEnabledboolean | null
forceAllReadersFirstInUnlockPendingLedFeedbackEnabledboolean | null
forceAllReadersOtherReaderUnlockAudioFeedbackEnabledboolean | null
forceAllReadersRemoteUnlockAudioFeedbackEnabledboolean | null
forcedOpenEnabledboolean | null
forcedOpenTimeSecinteger<int32> | null
geofenceEnabledboolean | null
geofenceRadiusnumber<double> | null
latitudenumber<double> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

longitudenumber<double> | null
namestring | null
nfcSecureDowngradeEnabledboolean | null
orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

policyUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

privacyModeSupportEnabledboolean | null
proximityUnlockSettingsobject
Show child attributes
credCooldownSecinteger<int32> | null
enabledboolean | null
exitResetsCooldownboolean | null
holdUnlockedboolean | null
holdUnlockedEventIntervalSecinteger<int32> | null
maxHoldUnlockedTimeSecinteger<int32> | null
minHoldUnlockedTimeSecinteger<int32> | null
minRSSIThresholdinteger<int32> | null
readerComponentsobject[] | null
Show child attributes
componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

relayComponentsobject[] | null
Show child attributes
componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

relockAfterOpenTimeMsinteger<int32> | null
remoteUnlockEnabledboolean | null
rexComponentsobject[] | null
Show child attributes
componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

schlageDoorExtensionComponentobject
Show child attributes
componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

schlageGatewayComponentobject
Show child attributes
componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

schlageGatewayRs485Addressinteger<int32> | null
schlageRs485Addressinteger<int32> | null
sendExpiredIntentEventsboolean | null
subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

subTypeenum<string>

Available options: RHOMBUS, APERIO, APERIO_RS485, SCHLAGE_R485

typeenum<string>

Available options: AccessControlledDoor, AccessControlledElevator, AccessControlledElevatorLanding

unlockTimeSecinteger<int32> | null
unlockTimeSecRexinteger<int32> | null
updatedAtMillisinteger<int64> | null
uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

waveToUnlockSettingsobject
Show child attributes
awaitAuthDurationMsinteger<int32> | null
enabledboolean | null
minRSSIThresholdinteger<int32> | null
showAwaitIntentFeedbackboolean | null
treatNfcAsIntentboolean | null
errorboolean | null
errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null
warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

  • 400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
  • 401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
  • 403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
  • 429 Too Many Requests. errorCode is one of: RATE_LIMITED.
  • 500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
  • 503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.