About

Add credentials to the access control list of the specified device. The credentials are not added to the device until a Sync Device Credentials call is initiated. Check the Devices Documentation to see if a Device supports credentials.

Parameters

PropertyLocationDetails

AccessKey

string
Required
Unique
Header

The access key for your user account.

This value is a 36-character GUID provided in your user profile.

DeviceName

string
Required
Unique
URL

The name of the device.

This value has a max length of 128 ASCII characters.

This value must adhere to this regular expression: ^[a-zA-Z0-9-_,. ]*$

Credentials

array(string)
Required

Body

Request

Response

The 10-digit hexadecimal RFID values of the access passes that this device should add to its access control list. Any letters must be upper case.

Note: This is not the 6-digit ID printed on the back of the access pass. That number is simply for visual identification.

Example

Request URL

POST https://api.jetstreamrfid.com/3/devices/{Device Name}/credentials/basic

Request Body

[
    "MYBASICCREDENTIALS1_VALUE", 
    "MYBASICCREDENTIALS2_VALUE", 
    "MYBASICCREDENTIALS3_VALUE"
]

Response Code

201 Created

Response Body

[
    "MYBASICCREDENTIALS1_VALUE", 
    "MYBASICCREDENTIALS2_VALUE", 
    "MYBASICCREDENTIALS3_VALUE"
]

Version Changes

A combination of this endpoint and the Sync Device Credentials endpoint replaces the Add and/or Remove Passes endpoint – specifically, the Add Passes part.