Access Control Components

Retrieve a list of components owned by a Rhombus device

Retrieve a list of components owned by a Rhombus device (i.e. DC20's device uuid)

POST/api/component/findComponentsByOwnerDevice

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

ownerDeviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/component/findComponentsByOwnerDevice' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }'

import requests

url = "https://api2.rhombussystems.com/api/component/findComponentsByOwnerDevice"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

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/findComponentsByOwnerDevice', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }),
});
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 = """
            {
              "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/component/findComponentsByOwnerDevice"))
            .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

{
  "components": [
    {
      "baseType": "reader",
      "createdAtMillis": 0,
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ownerHardwareType": "RASPBERRY_PI_3",
      "portImmutable": true,
      "type": "RhombusOsdpDoorReader",
      "updatedAtMillis": 0,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "allowCredsDuringUnlock": true,
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "disableCardReader": true,
      "disableKeypad": true,
      "disableQrScanner": true,
      "disableWaveToUnlock": true,
      "disposition": "INGRESS",
      "hardwareUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "osdpAddress": 0,
      "otherReaderUnlockAudioFeedbackEnabled": true,
      "port": {
        "boardNum": 0,
        "portNum": 0,
        "portType": "RS485"
      },
      "readerType": "wiegand",
      "remoteUnlockAudioFeedbackEnabled": true,
      "serialNumber": "<string>"
    }
  ]
}

Response

200 OK

application/json · object

componentsobject[] | null

Show child attributes

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

Available options: RASPBERRY_PI_3, CAMERA_R1, CAMERA_R2, CAMERA_R2_LONG_RANGE, CAMERA_R2_180, CAMERA_R3, CAMERA_R4, CAMERA_R100, CAMERA_R120, CAMERA_R170, CAMERA_R200, CAMERA_R500, CAMERA_R510, CAMERA_R520, CAMERA_R600, SENSOR_ASSET_TAG_T1, SENSOR_DOOR_D1, SENSOR_DOOR_D20, SENSOR_ENVIRONMENTAL_E1, SENSOR_ENVIRONMENTAL_E15, SENSOR_ENVIRONMENTAL_E2, SENSOR_MOTION_M1, SENSOR_MOTION_M15, GATEWAY_A1, GATEWAY_A100, GATEWAY_ENVIRONMENTAL_E50, CAMERA_R220, CAMERA_R230, CAMERA_R36S, CAMERA_R410, CAMERA_R540, CAMERA_R545, BADGE_READER_DR1, BADGE_READER_DR40, BADGE_READER_DR20, DOOR_CONTROLLER_DC1, DOOR_CONTROLLER_DC20, DOOR_CONTROLLER_DC10, ETHERNET_TESTER_ET1, IO_BOARD_TB1, BLE_BUTTON_B10, BLE_BUTTON_B15, CAMERA_THIRD_PARTY_RELAY, CAMERA_THIRD_PARTY_NVR, CAMERA_THIRD_PARTY_NVR_MULTISENSOR, NVR_N100, CAMERA_R130, NVR_N500, CAMERA_R150, ROBOT_RC1, CAMERA_R210, CAMERA_R650, NVR_N550, NVR_N551, ROBOT_RC2, UNSPECIFIED

portImmutableboolean | null

typeenum<string>

Available options: RhombusOsdpDoorReader, OsdpDoorReader, WiegandDoorReader, IntegratedDoorPositionIndicator, IntegratedRequestToExit, IntegratedDoorRelay, IntegratedGenericRelay, IntegratedGenericInput, IntegratedGenericButton, SchlageInputButton, AperioActivatorButton, AperioGateway, AperioRs485Gateway, AperioDoorExtension, AperioDoorRelay, AperioDoorPositionIndicator, AperioDoorReader, AperioRs485DoorReader, AperioRs485DoorRelay, AperioRs485DoorPositionIndicator, AperioRs485DoorRequestToExit, AperioRs485DoorExtension, AperioDoorRequestToExit, SchlageRs485Gateway, SchlageRs485DoorExtension, SchlageRs485DoorRelay, SchlageRs485DoorPositionIndicator, SchlageRs485DoorReader, SchlageRs485DoorRequestToExit

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

One of:

Show Rhombus Osdp Door Reader Type variant

allowCredsDuringUnlockboolean | null

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

disableCardReaderboolean | null

disableKeypadboolean | null

disableQrScannerboolean | null

disableWaveToUnlockboolean | null

dispositionenum<string>

Available options: INGRESS, EGRESS, UNKNOWN

hardwareUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

osdpAddressinteger<int32> | null

otherReaderUnlockAudioFeedbackEnabledboolean | null

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: RS485

portImmutableboolean | null

readerTypeenum<string>

Available options: wiegand, osdp, rhombus_osdp, aperio_wireless, aperio_rs485, schlage_wireless, schlage_rs485

remoteUnlockAudioFeedbackEnabledboolean | null

serialNumberstring | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Osdp Door Reader Type variant

allowUnencryptedboolean | null

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

disableCardReaderboolean | null

disableKeypadboolean | null

disableWaveToUnlockboolean | null

dispositionenum<string>

Available options: INGRESS, EGRESS, UNKNOWN

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

osdpAddressinteger<int32> | null

otherReaderUnlockAudioFeedbackEnabledboolean | null

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: RS485

portImmutableboolean | null

readerTypeenum<string>

Available options: wiegand, osdp, rhombus_osdp, aperio_wireless, aperio_rs485, schlage_wireless, schlage_rs485

remoteUnlockAudioFeedbackEnabledboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Wiegand Door Reader Type variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

buzzerPortobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: WIEGAND_OUTPUT

createdAtMillisinteger<int64> | null

csnEndianenum<string>

Available options: MSB, LSB

d0Portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: WIEGAND_INPUT

d1Portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: WIEGAND_INPUT

disableCardReaderboolean | null

disableKeypadboolean | null

disableWaveToUnlockboolean | null

dispositionenum<string>

Available options: INGRESS, EGRESS, UNKNOWN

gledPortobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: WIEGAND_OUTPUT

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

otherReaderUnlockAudioFeedbackEnabledboolean | null

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portImmutableboolean | null

readerTypeenum<string>

Available options: wiegand, osdp, rhombus_osdp, aperio_wireless, aperio_rs485, schlage_wireless, schlage_rs485

remoteUnlockAudioFeedbackEnabledboolean | null

rledPortobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: WIEGAND_OUTPUT

tamperPortobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: WIEGAND_INPUT, GPIO_INPUT

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Integrated Door Position Indicator Type variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

dpiTypeenum<string>

Available options: integrated, remote

namestring | null

normalStateenum<string>

Available options: NO, NC

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: GPIO_INPUT, GPIO_INPUT_SUPERVISED

supervisionConfigurationobject

Show child attributes

modeenum<string>

Available options: CUT_DETECT, SHORT_DETECT, CUT_AND_SHORT_DETECT

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Integrated Request To Exit Type variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

intentOnlyboolean | null

intentOnlyEventsboolean | null

namestring | null

normalStateenum<string>

Available options: NO, NC

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: GPIO_INPUT, GPIO_INPUT_SUPERVISED

supervisionConfigurationobject

Show child attributes

modeenum<string>

Available options: CUT_DETECT, SHORT_DETECT, CUT_AND_SHORT_DETECT

portImmutableboolean | null

rexTypeenum<string>

Available options: integrated, remote

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Integrated Door Relay Type variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: GPIO_OUTPUT

portImmutableboolean | null

rateLimitingEnabledboolean | null

relayTypeenum<string>

Available options: integrated, remote

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Integrated Generic Relay Type variant

auxTypeenum<string>

Available options: integrated_generic_input, integrated_generic_relay

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

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

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: GPIO_OUTPUT

portImmutableboolean | null

relayDurationSecinteger<int32> | null

Deprecated, do not use.

stateChangedAtMillisinteger<int64> | null

steadyStateenum<string>

Available options: ACTIVE, INACTIVE, UNKNOWN

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Integrated Generic Input Type variant

auxTypeenum<string>

Available options: integrated_generic_input, integrated_generic_relay

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

normalStateenum<string>

Available options: NO, NC

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: GPIO_INPUT, GPIO_INPUT_SUPERVISED

supervisionConfigurationobject

Show child attributes

modeenum<string>

Available options: CUT_DETECT, SHORT_DETECT, CUT_AND_SHORT_DETECT

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Integrated Generic Button Type variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

buttonTypeenum<string>

Available options: integrated_generic_button, integrated_doorbell_button, schlage_rs485_input_button, aperio_rs485_activator_button

createdAtMillisinteger<int64> | null

modeenum<string>

Optional button mode configuration

Available options: PANIC, PROGRAMMABLE, DOORBELL, NONE

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: GPIO_INPUT, BUTTON_INPUT

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Schlage Input Button variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

buttonTypeenum<string>

Available options: integrated_generic_button, integrated_doorbell_button, schlage_rs485_input_button, aperio_rs485_activator_button

gatewayRs485Addressinteger<int32> | null

ipbFunctionenum<string>

Available options: NONE, PRIVACY

modeenum<string>

Optional button mode configuration

Available options: PANIC, PROGRAMMABLE, DOORBELL, NONE

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: RS485

rs485Addressinteger<int32> | nullrequired

Show Aperio Activator Button variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

activatorFunctionenum<string>

Available options: NONE, PRIVACY

buttonTypeenum<string>

Available options: integrated_generic_button, integrated_doorbell_button, schlage_rs485_input_button, aperio_rs485_activator_button

eacAddressinteger<int32> | nullrequired

gatewayEacAddressinteger<int32> | null

modeenum<string>

Optional button mode configuration

Available options: PANIC, PROGRAMMABLE, DOORBELL, NONE

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: RS485

Show Aperio Gateway variant

aperioGatewayIdstring<byte>[] | null

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

hwVersionstring<byte>[] | null

namestring | null

oemCodestring | null

oemGeneratedAtMsinteger<int64> | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Aperio Door Reader variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

aperioDoorIdstring | null

aperioGatewayIdstring<byte>[] | null

disableCardReaderboolean | null

disableKeypadboolean | null

disableWaveToUnlockboolean | null

dispositionenum<string>

Available options: INGRESS, EGRESS, UNKNOWN

otherReaderUnlockAudioFeedbackEnabledboolean | null

readerTypeenum<string>

Available options: wiegand, osdp, rhombus_osdp, aperio_wireless, aperio_rs485, schlage_wireless, schlage_rs485

remoteUnlockAudioFeedbackEnabledboolean | null

Show Aperio Door Extension variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

aperioDoorDeviceIdstring<byte>[] | nullrequired

aperioDoorIdstring | nullrequired

aperioGatewayIdstring<byte>[] | nullrequired

Show Aperio Door Relay variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

aperioDoorIdstring | null

aperioGatewayIdstring<byte>[] | null

deviceIdstring<byte>[] | null

relayTypeenum<string>

Available options: integrated, remote

Show Aperio Door Position Indicator variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

aperioDoorIdstring | null

aperioGatewayIdstring<byte>[] | null

dpiTypeenum<string>

Available options: integrated, remote

normalStateenum<string>

Available options: NO, NC

Show Aperio Rs 485 Gateway variant

aperioGatewayIdstring<byte>[] | null

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

eacAddressinteger<int32> | null

hwVersionstring<byte>[] | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: RS485

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Aperio Rs 485 Door Reader variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

disableCardReaderboolean | null

disableKeypadboolean | null

disableWaveToUnlockboolean | null

dispositionenum<string>

Available options: INGRESS, EGRESS, UNKNOWN

eacAddressinteger<int32> | nullrequired

gatewayEacAddressinteger<int32> | null

otherReaderUnlockAudioFeedbackEnabledboolean | null

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: RS485

readerTypeenum<string>

Available options: wiegand, osdp, rhombus_osdp, aperio_wireless, aperio_rs485, schlage_wireless, schlage_rs485

remoteUnlockAudioFeedbackEnabledboolean | null

Show Aperio Rs 485 Door Relay variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

eacAddressinteger<int32> | null

gatewayEacAddressinteger<int32> | null

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: RS485

rateLimitingEnabledboolean | null

relayTypeenum<string>

Available options: integrated, remote

Show Aperio Rs 485 Door Position Indicator variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

dpiTypeenum<string>

Available options: integrated, remote

eacAddressinteger<int32> | null

gatewayEacAddressinteger<int32> | null

normalStateenum<string>

Available options: NO, NC

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: RS485

Show Aperio Rs 485 Door Request To Exit variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

eacAddressinteger<int32> | null

gatewayEacAddressinteger<int32> | null

intentOnlyboolean | null

intentOnlyEventsboolean | null

normalStateenum<string>

Available options: NO, NC

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: RS485

rexTypeenum<string>

Available options: integrated, remote

Show Aperio Rs 485 Door Extension variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

eacAddressinteger<int32> | null

gatewayEacAddressinteger<int32> | null

modelenum<string>

Available options: C100_V3, E100_V3, L100_V3, H100_V3, AU100_V3, IN100_V3_MC, G100_V3, KL100_V3, K100_V3_MC, KS100_V3_MC, ES100_V3_MC, DL100_V3_MC, DR100_V3_MC, R100_V3_MC, C100, C100_V2SE, E100, E100_V2SE, L100, PROFILE_N2_MORTISE, INCEPTA, A100, K100, K100DI, KS100, M100, R100

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: RS485

Show Schlage Rs 485 Gateway variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

baudinteger<int32> | null

createdAtMillisinteger<int64> | null

frameCheckenum<string>

Available options: SCHLAGE_RSI_CRC, SCHLAGE_RSI_CHECKSUM

hwVersionstring | null

modelstring | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: RS485

portImmutableboolean | null

rs485Addressinteger<int32> | nullrequired

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Schlage Rs 485 Door Reader variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

disableCardReaderboolean | null

disableKeypadboolean | null

disableWaveToUnlockboolean | null

dispositionenum<string>

Available options: INGRESS, EGRESS, UNKNOWN

gatewayRs485Addressinteger<int32> | null

otherReaderUnlockAudioFeedbackEnabledboolean | null

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: RS485

readerTypeenum<string>

Available options: wiegand, osdp, rhombus_osdp, aperio_wireless, aperio_rs485, schlage_wireless, schlage_rs485

remoteUnlockAudioFeedbackEnabledboolean | null

rs485Addressinteger<int32> | nullrequired

Show Schlage Rs 485 Door Extension variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

apmFamilyenum<string>

Available options: AD_WIRED, AD_WIRELESS, ENGAGE, RMRU

gatewayRs485Addressinteger<int32> | null

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: RS485

rs485Addressinteger<int32> | null

Show Schlage Rs 485 Door Relay variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

gatewayRs485Addressinteger<int32> | null

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: RS485

relayTypeenum<string>

Available options: integrated, remote

rs485Addressinteger<int32> | null

Show Schlage Rs 485 Door Position Indicator variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

dpiTypeenum<string>

Available options: integrated, remote

gatewayRs485Addressinteger<int32> | null

normalStateenum<string>

Available options: NO, NC

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: RS485

rs485Addressinteger<int32> | null

Show Schlage Rs 485 Door Request To Exit variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

portImmutableboolean | null

typeenum<string>

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

gatewayRs485Addressinteger<int32> | null

intentOnlyboolean | null

intentOnlyEventsboolean | null

normalStateenum<string>

Available options: NO, NC

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: RS485

rexTypeenum<string>

Available options: integrated, remote

rs485Addressinteger<int32> | 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.