Sync Device Credentials

About

Instruct the specified device to set/sync its access control list to the credentials associated with the specified device in Jetstream.

Command Type	Device is Online	Device is Offline
Synchronous, Queueable	Immediate execution, Immediate results and published results	Queued execution, Published results

Parameters

Property

Location

Details

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-_,. ]*$

Example

Request URL

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

Request Body

None Required

Response Code

200 OK

Response Body

{
    "CommandId": "5be4a19c-f1c3-42a9-b437-eacf5272bb8d",
    "Status": "Completed",
    "ExceptionList": [],
    "OutputParameterList": []
}

Published CommandQueuedEvent

{
    "Device": "MyDeviceName",
    "CommandId": "5be4a19c-f1c3-42a9-b437-eacf5272bb8d",
    "CommandName": "SyncCredentials",
    "URI": "/3/Devices/MyDeviceName/credentials/sync",
    "Verb": "Post",
    "User": "MyUserName",
    "Parameters": [
        {
            "Key": "Add"
            "Value": "MyBasicCredentials1_Value"
        },
        {
            "Key": "Add",
            "Value": "MyBasicCredentials2_Value"
        },
        {
            "Key": "Add",
            "Value": "MyBasicCredentials3_Value"
        },
        {
            "Key": "Remove",
            "Value": "*"
        }
    ],
    "Type": "CommandQueuedEvent",
    "EventId": "7e830645-0c77-4a1d-9666-1e5b6c320947",
    "EventTime": "2018-05-17T13:51:08Z",
    "Version": 2
}

Published CommandCompletionEvent

{
    "CommandId": "0093fac7-1d82-430a-8bd2-0562c2067037",
    "CommandName": "SyncCredentials",
    "OutputParameterList": [],
    "ExceptionList": [],
    "Device": "MyDeviceName",
    "ReceivedTime": "2018-05-16T21:17:13Z",
    "Type": "CommandCompletionEvent",
    "EventId": "59236a58-2581-4f10-be5c-44c11e681794",
    "EventTime": "2018-05-16T21:17:12Z",
    "Version": 2
}

Version Changes

A combination of this endpoint, Create Device Credentials, Modify Device Credentials, and Delete Device Credentials replaces Add and/or Remove Passes and Replace All Passes.