Access Control Components

Find access controlled door shadows within the specified location

POST/api/component/findAccessControlledDoorShadowsByLocation

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

lastEvaluatedKeystring | nullbody

locationUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

maxPageSizeinteger<int32> | nullbody

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/component/findAccessControlledDoorShadowsByLocation' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "lastEvaluatedKey": "<string>",
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "maxPageSize": 0
  }'

import requests

url = "https://api2.rhombussystems.com/api/component/findAccessControlledDoorShadowsByLocation"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "lastEvaluatedKey": "<string>",
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "maxPageSize": 0
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/component/findAccessControlledDoorShadowsByLocation', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "lastEvaluatedKey": "<string>",
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "maxPageSize": 0
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "lastEvaluatedKey": "<string>",
              "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "maxPageSize": 0
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/component/findAccessControlledDoorShadowsByLocation"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "lastEvaluatedKey": "<string>",
  "shadows": [
    {
      "authFirstIn": {
        "originator": {
          "auditPrincipal": "<string>",
          "type": "USER",
          "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "grantedToName": "<string>",
          "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "supportUserEmail": "<string>",
          "supportUsername": "<string>"
        },
        "source": "CONFIG_MANUAL_OVERRIDE",
        "state": "DISABLED",
        "stateUpdateEventTimestampMs": 0
      },
      "componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "createdAtMillis": 0,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "scheduleFirstIn": {
        "originator": {
          "auditPrincipal": "<string>",
          "type": "USER",
          "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "grantedToName": "<string>",
          "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "supportUserEmail": "<string>",
          "supportUsername": "<string>"
        },
        "source": "CONFIG_MANUAL_OVERRIDE",
        "state": "DISABLED",
        "stateUpdateEventTimestampMs": 0
      },
      "state": {
        "originator": {
          "auditPrincipal": "<string>",
          "type": "USER",
          "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "grantedToName": "<string>",
          "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "supportUserEmail": "<string>",
          "supportUsername": "<string>"
        },
        "source": "DEFAULT_STATE",
        "state": "UNLOCKED",
        "stateUpdateEventTimestampMs": 0
      },
      "type": "AccessControlledDoorShadow",
      "updatedAtMillis": 0
    }
  ]
}

Response

200 OK

application/json · object

lastEvaluatedKeystring | null

shadowsobject[] | null

Show child attributes

authFirstInobject

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

sourceenum<string>

Available options: CONFIG_MANUAL_OVERRIDE, CONFIG_REQUIREMENT_CHANGE, CONFIG_MEMBERSHIP, SCHEDULED_RESET, LOCAL_BADGE_EVENT, LOCKDOWN, UNKNOWN

stateenum<string>

Available options: DISABLED, NOT_CONFIGURED, REQUIRED, SATISFIED, UNKNOWN

stateUpdateEventTimestampMsinteger<int64> | null

componentCompositeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

scheduleFirstInobject

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

sourceenum<string>

Available options: CONFIG_MANUAL_OVERRIDE, CONFIG_REQUIREMENT_CHANGE, CONFIG_MEMBERSHIP, SCHEDULED_RESET, LOCAL_BADGE_EVENT, LOCKDOWN, UNKNOWN

stateenum<string>

Available options: DISABLED, NOT_CONFIGURED, REQUIRED, SATISFIED, UNKNOWN

stateUpdateEventTimestampMsinteger<int64> | null

stateobject

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

sourceenum<string>

Available options: DEFAULT_STATE, SCHEDULE, SCHEDULE_EXCEPTION, FIRST_IN, DOOR_STATE_OVERRIDE, LOCKDOWN, PRIVACY, UNKNOWN

stateenum<string>

Available options: UNLOCKED, ACCESS_CONTROLLED

stateUpdateEventTimestampMsinteger<int64> | null

typeenum<string>

Available options: AccessControlledDoorShadow, AccessControlledElevatorLandingShadow

updatedAtMillisinteger<int64> | 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.