<- Object

Object

All versions ->

DeviceCode

Link to section

Properties

Link to section

id

string

Read only The unique id for this device code.

Link to section

name

string

An optional user-defined name for the device code.

Max Length
128
Link to section

code

string

Read only The unique code that can be used to login.

Link to section

device_id

string

Read only The unique id of the device that used this code. Populated when the device is paired up.

Link to section

product_type

string

Required

The targeting product type of the device code.

Link to section

location_id

string

The location assigned to this code.

Max Length
50
Link to section

status

string

Read only The pairing status of the device code.

Link to section

pair_by

string

Read only When this DeviceCode will expire and no longer login. Timestamp in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

created_at

string

Read only When this DeviceCode was created. Timestamp in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

status_changed_at

string

Read only When this DeviceCode's status was last changed. Timestamp in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

paired_at

string

Read only When this DeviceCode was paired. Timestamp in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00