Access Control

Create access control credential by hex value and type

Create a credential based on a hex value and credential type. Useful if you see an unauthorized badge event, know its type and want to import it

POST/api/accesscontrol/createAccessControlCredentialByHexValueAndType

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

Request to create an access control credential by hex value and type.

credentialTypeenum<string>body

Available options: STANDARD_CSN, RHOMBUS_SECURE_CSN, RHOMBUS_SECURE_MOBILE, APPLE_WALLET_DESFIRE, RHOMBUS_SECURE_NFC, PIN_CODE, WIEGAND_H10301, WIEGAND_H10304, WIEGAND_H10302, WIEGAND_D10202, WIEGAND_64BIT_RAW, HID_CORP1000_STD_35, HID_CORP1000_STD_48, QR_CODE_STATIC, CUSTOM

endDateEpochSecExclusiveinteger<int64> | nullbody

End date in epoch seconds (exclusive)

Example: 1672531200

hexValuestring | nullbody

Hex value of the credential

Example: "1234567890ABCDEF"

littleEndianboolean | nullbody

Only needed when creating Wiegand credentials

numValueBitsinteger<int32> | nullbody

Only needed when creating Wiegand credentials

startDateEpochSecInclusiveinteger<int64> | nullbody

Start date in epoch seconds (inclusive)

Example: 1640995200

userUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/accesscontrol/createAccessControlCredentialByHexValueAndType' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "credentialType": "STANDARD_CSN",
    "endDateEpochSecExclusive": 1672531200,
    "hexValue": "1234567890ABCDEF",
    "littleEndian": true,
    "numValueBits": 0,
    "startDateEpochSecInclusive": 1640995200,
    "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }'

import requests

url = "https://api2.rhombussystems.com/api/accesscontrol/createAccessControlCredentialByHexValueAndType"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "credentialType": "STANDARD_CSN",
    "endDateEpochSecExclusive": 1672531200,
    "hexValue": "1234567890ABCDEF",
    "littleEndian": True,
    "numValueBits": 0,
    "startDateEpochSecInclusive": 1640995200,
    "userUuid": "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/accesscontrol/createAccessControlCredentialByHexValueAndType', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "credentialType": "STANDARD_CSN",
    "endDateEpochSecExclusive": 1672531200,
    "hexValue": "1234567890ABCDEF",
    "littleEndian": true,
    "numValueBits": 0,
    "startDateEpochSecInclusive": 1640995200,
    "userUuid": "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 = """
            {
              "credentialType": "STANDARD_CSN",
              "endDateEpochSecExclusive": 1672531200,
              "hexValue": "1234567890ABCDEF",
              "littleEndian": true,
              "numValueBits": 0,
              "startDateEpochSecInclusive": 1640995200,
              "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/accesscontrol/createAccessControlCredentialByHexValueAndType"))
            .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

{
  "credential": {
    "assigneeType": "USER",
    "assigneeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "createdAtMillis": 0,
    "endDateEpochSecExclusive": 0,
    "lastUsedAccessControlledDoorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "lastUsedAtMillis": 0,
    "lastUsedLocationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "lowercaseHexValue": "<string>",
    "managedCredUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "note": "<string>",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "startDateEpochSecInclusive": 0,
    "type": "STANDARD_CSN",
    "updatedAtMillis": 0,
    "userUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "value": "<string>",
    "workflowStatus": "ACTIVE"
  }
}

Response

200 OK

application/json · object

Response for access control credential creation by hex value and type.

credentialobject

Credentials assigned to the pass.

Show child attributes

assigneeTypeenum<string>

Available options: USER, GUEST_PASS

assigneeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

endDateEpochSecExclusiveinteger<int64> | null

lastUsedAccessControlledDoorUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lastUsedAtMillisinteger<int64> | null

lastUsedLocationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lowercaseHexValuestring | null

managedCredUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

notestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

startDateEpochSecInclusiveinteger<int64> | null

typeenum<string>

updatedAtMillisinteger<int64> | null

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

valuestring | null

workflowStatusenum<string>

Available options: ACTIVE, UNASSIGNED, SUSPENDED, REVOKED

One of:

Show Standard Csn Type variant

assigneeTypeenum<string>

Available options: USER, GUEST_PASS

assigneeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

endDateEpochSecExclusiveinteger<int64> | null

lastUsedAccessControlledDoorUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lastUsedAtMillisinteger<int64> | null

lastUsedLocationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lowercaseHexValuestring | null

managedCredUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

notestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

startDateEpochSecInclusiveinteger<int64> | null

typeenum<string>

updatedAtMillisinteger<int64> | null

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

valuestring | null

workflowStatusenum<string>

Available options: ACTIVE, UNASSIGNED, SUSPENDED, REVOKED

Show Rhombus Secure Csn Type variant

assigneeTypeenum<string>

Available options: USER, GUEST_PASS

assigneeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

endDateEpochSecExclusiveinteger<int64> | null

lastUsedAccessControlledDoorUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lastUsedAtMillisinteger<int64> | null

lastUsedLocationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lowercaseHexValuestring | null

managedCredUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

notestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

startDateEpochSecInclusiveinteger<int64> | null

typeenum<string>

updatedAtMillisinteger<int64> | null

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

valuestring | null

workflowStatusenum<string>

Available options: ACTIVE, UNASSIGNED, SUSPENDED, REVOKED

algorithmenum<string>

Available options: AN10922_AES128

baseKeyIdentifierinteger<int32> | null

Show Rhombus Secure Mobile Type variant

assigneeTypeenum<string>

Available options: USER, GUEST_PASS

assigneeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

endDateEpochSecExclusiveinteger<int64> | null

lastUsedAccessControlledDoorUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lastUsedAtMillisinteger<int64> | null

lastUsedLocationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lowercaseHexValuestring | null

managedCredUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

notestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

startDateEpochSecInclusiveinteger<int64> | null

typeenum<string>

updatedAtMillisinteger<int64> | null

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

valuestring | null

workflowStatusenum<string>

Available options: ACTIVE, UNASSIGNED, SUSPENDED, REVOKED

algorithmenum<string>

Available options: AN10922_AES128

appNamestring | null

appNotificationsobject | null

Show child attributes

settingsobject[] | null

Show child attributes

namestring | null

statusenum<string>

Available options: OPTIMAL, INHIBITED

valuestring | null

statusenum<string>

Available options: OPT_OUT, UNAVAILABLE, OPTIMAL, INHIBITED, UNKNOWN

appOSstring | null

appStatusUpdatedAtMillisinteger<int64> | null

appVersionstring | null

baseKeyIdentifierinteger<int32> | null

clientTypeenum<string>

Available options: IOS, ANDROID

deviceModelstring | null

installationIdstring | null

tapToUnlockobject | null

Show child attributes

settingsobject[] | null

Show child attributes

namestring | null

statusenum<string>

Available options: OPTIMAL, INHIBITED

valuestring | null

statusenum<string>

Available options: OPT_OUT, UNAVAILABLE, OPTIMAL, INHIBITED, UNKNOWN

userAgentstring | null

waveToUnlockobject | null

Show child attributes

settingsobject[] | null

Show child attributes

namestring | null

statusenum<string>

Available options: OPTIMAL, INHIBITED

valuestring | null

statusenum<string>

Available options: OPT_OUT, UNAVAILABLE, OPTIMAL, INHIBITED, UNKNOWN

Show Pin Credential variant

assigneeTypeenum<string>

Available options: USER, GUEST_PASS

assigneeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

endDateEpochSecExclusiveinteger<int64> | null

lastUsedAccessControlledDoorUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lastUsedAtMillisinteger<int64> | null

lastUsedLocationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lowercaseHexValuestring | null

managedCredUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

notestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

startDateEpochSecInclusiveinteger<int64> | null

typeenum<string>

updatedAtMillisinteger<int64> | null

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

valuestring | null

workflowStatusenum<string>

Available options: ACTIVE, UNASSIGNED, SUSPENDED, REVOKED

Show Wiegand H 10301 Credential Type variant

assigneeTypeenum<string>

Available options: USER, GUEST_PASS

assigneeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

endDateEpochSecExclusiveinteger<int64> | null

lastUsedAccessControlledDoorUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lastUsedAtMillisinteger<int64> | null

lastUsedLocationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lowercaseHexValuestring | null

managedCredUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

notestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

startDateEpochSecInclusiveinteger<int64> | null

typeenum<string>

updatedAtMillisinteger<int64> | null

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

valuestring | null

workflowStatusenum<string>

Available options: ACTIVE, UNASSIGNED, SUSPENDED, REVOKED

cardNumberinteger<int32> | null

facilityCodeinteger<int32> | null

formatenum<string>

Available options: H10301, D10202, H10304, H10302, HID_CORP1000_STD_35, HID_CORP1000_STD_48, WIEGAND_64BIT_RAW, CUSTOM

nonParityValuestring | null

Show Wiegand H 10304 Credential variant

assigneeTypeenum<string>

Available options: USER, GUEST_PASS

assigneeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

endDateEpochSecExclusiveinteger<int64> | null

lastUsedAccessControlledDoorUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lastUsedAtMillisinteger<int64> | null

lastUsedLocationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lowercaseHexValuestring | null

managedCredUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

notestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

startDateEpochSecInclusiveinteger<int64> | null

typeenum<string>

updatedAtMillisinteger<int64> | null

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

valuestring | null

workflowStatusenum<string>

Available options: ACTIVE, UNASSIGNED, SUSPENDED, REVOKED

cardNumberinteger<int32> | null

facilityCodeinteger<int32> | null

formatenum<string>

Available options: H10301, D10202, H10304, H10302, HID_CORP1000_STD_35, HID_CORP1000_STD_48, WIEGAND_64BIT_RAW, CUSTOM

nonParityValuestring | null

Show Wiegand H 10302 Credential variant

assigneeTypeenum<string>

Available options: USER, GUEST_PASS

assigneeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

endDateEpochSecExclusiveinteger<int64> | null

lastUsedAccessControlledDoorUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lastUsedAtMillisinteger<int64> | null

lastUsedLocationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lowercaseHexValuestring | null

managedCredUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

notestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

startDateEpochSecInclusiveinteger<int64> | null

typeenum<string>

updatedAtMillisinteger<int64> | null

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

valuestring | null

workflowStatusenum<string>

Available options: ACTIVE, UNASSIGNED, SUSPENDED, REVOKED

cardNumberinteger<int64> | null

formatenum<string>

Available options: H10301, D10202, H10304, H10302, HID_CORP1000_STD_35, HID_CORP1000_STD_48, WIEGAND_64BIT_RAW, CUSTOM

nonParityValuestring | null

Show Wiegand D 10202 Credential variant

assigneeTypeenum<string>

Available options: USER, GUEST_PASS

assigneeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

endDateEpochSecExclusiveinteger<int64> | null

lastUsedAccessControlledDoorUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lastUsedAtMillisinteger<int64> | null

lastUsedLocationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lowercaseHexValuestring | null

managedCredUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

notestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

startDateEpochSecInclusiveinteger<int64> | null

typeenum<string>

updatedAtMillisinteger<int64> | null

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

valuestring | null

workflowStatusenum<string>

Available options: ACTIVE, UNASSIGNED, SUSPENDED, REVOKED

cardNumberinteger<int32> | null

facilityCodeinteger<int32> | null

formatenum<string>

Available options: H10301, D10202, H10304, H10302, HID_CORP1000_STD_35, HID_CORP1000_STD_48, WIEGAND_64BIT_RAW, CUSTOM

nonParityValuestring | null

Show Wiegand 64 Bit Raw Credential Type variant

assigneeTypeenum<string>

Available options: USER, GUEST_PASS

assigneeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

endDateEpochSecExclusiveinteger<int64> | null

lastUsedAccessControlledDoorUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lastUsedAtMillisinteger<int64> | null

lastUsedLocationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lowercaseHexValuestring | null

managedCredUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

notestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

startDateEpochSecInclusiveinteger<int64> | null

typeenum<string>

updatedAtMillisinteger<int64> | null

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

valuestring | null

workflowStatusenum<string>

Available options: ACTIVE, UNASSIGNED, SUSPENDED, REVOKED

cardNumberinteger<int64> | null

formatenum<string>

Available options: H10301, D10202, H10304, H10302, HID_CORP1000_STD_35, HID_CORP1000_STD_48, WIEGAND_64BIT_RAW, CUSTOM

Show Wiegand 35 Bit Corp 1000 Credential variant

assigneeTypeenum<string>

Available options: USER, GUEST_PASS

assigneeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

endDateEpochSecExclusiveinteger<int64> | null

lastUsedAccessControlledDoorUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lastUsedAtMillisinteger<int64> | null

lastUsedLocationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lowercaseHexValuestring | null

managedCredUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

notestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

startDateEpochSecInclusiveinteger<int64> | null

typeenum<string>

updatedAtMillisinteger<int64> | null

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

valuestring | null

workflowStatusenum<string>

Available options: ACTIVE, UNASSIGNED, SUSPENDED, REVOKED

cardNumberinteger<int64> | null

companyIdinteger<int32> | null

formatenum<string>

Available options: H10301, D10202, H10304, H10302, HID_CORP1000_STD_35, HID_CORP1000_STD_48, WIEGAND_64BIT_RAW, CUSTOM

Show Wiegand 48 Bit Corp 1000 Credential variant

assigneeTypeenum<string>

Available options: USER, GUEST_PASS

assigneeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

endDateEpochSecExclusiveinteger<int64> | null

lastUsedAccessControlledDoorUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lastUsedAtMillisinteger<int64> | null

lastUsedLocationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lowercaseHexValuestring | null

managedCredUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

notestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

startDateEpochSecInclusiveinteger<int64> | null

typeenum<string>

updatedAtMillisinteger<int64> | null

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

valuestring | null

workflowStatusenum<string>

Available options: ACTIVE, UNASSIGNED, SUSPENDED, REVOKED

cardNumberinteger<int64> | null

companyIdinteger<int32> | null

formatenum<string>

Available options: H10301, D10202, H10304, H10302, HID_CORP1000_STD_35, HID_CORP1000_STD_48, WIEGAND_64BIT_RAW, CUSTOM

Show Qr Code Static Credential variant

assigneeTypeenum<string>

Available options: USER, GUEST_PASS

assigneeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

endDateEpochSecExclusiveinteger<int64> | null

lastUsedAccessControlledDoorUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lastUsedAtMillisinteger<int64> | null

lastUsedLocationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lowercaseHexValuestring | null

managedCredUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

notestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

startDateEpochSecInclusiveinteger<int64> | null

typeenum<string>

updatedAtMillisinteger<int64> | null

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

valuestring | null

workflowStatusenum<string>

Available options: ACTIVE, UNASSIGNED, SUSPENDED, REVOKED

formatVersioninteger<int32> | null

Show Custom Credential variant

assigneeTypeenum<string>

Available options: USER, GUEST_PASS

assigneeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

endDateEpochSecExclusiveinteger<int64> | null

lastUsedAccessControlledDoorUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lastUsedAtMillisinteger<int64> | null

lastUsedLocationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lowercaseHexValuestring | null

managedCredUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

notestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

startDateEpochSecInclusiveinteger<int64> | null

typeenum<string>

updatedAtMillisinteger<int64> | null

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

valuestring | null

workflowStatusenum<string>

Available options: ACTIVE, UNASSIGNED, SUSPENDED, REVOKED

bitGroupValuesobject | null

customFormatNamestring | null

formatenum<string>

Available options: H10301, D10202, H10304, H10302, HID_CORP1000_STD_35, HID_CORP1000_STD_48, WIEGAND_64BIT_RAW, CUSTOM

naturalIdstring | null

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