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

Create access control credential by hex value and type

cURL

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

200

{
  "credential": {
    "createdAtMillis": 123,
    "endDateEpochSecExclusive": 123,
    "lastUsedAccessControlledDoorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "lastUsedAtMillis": 123,
    "lastUsedLocationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "lowercaseHexValue": "<string>",
    "managedCredUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "note": "<string>",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "startDateEpochSecInclusive": 123,
    "updatedAtMillis": 123,
    "userUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "value": "<string>"
  }
}

Authorizations

x-auth-apikey · string · header · required

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

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

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

Body

application/json

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

credentialType · enum<string>

Available options: STANDARD_CSN, RHOMBUS_SECURE_CSN, RHOMBUS_SECURE_MOBILE, PIN_CODE, WIEGAND_H10301, WIEGAND_H10304, WIEGAND_D10202, WIEGAND_64BIT_RAW, HID_CORP1000_STD_35, HID_CORP1000_STD_48, CUSTOM

endDateEpochSecExclusive · integer<int64> | null

End date in epoch seconds (exclusive)

Example:

1672531200

hexValue · string | null

Hex value of the credential

Example:

"1234567890ABCDEF"

littleEndian · boolean | null

Only needed when creating Wiegand credentials

numValueBits · integer<int32> | null

Only needed when creating Wiegand credentials

startDateEpochSecInclusive · integer<int64> | null

Start date in epoch seconds (inclusive)

Example:

1640995200

userUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

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

credential · object

Updated Wiegand credential details

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Show child attributes