Skip to content

Token

Manage Access Tokens.

Action

Perform a token action: delete, new, resume, revoke, suspend.

Endpoint

HTTP
POST /token/action

Authorized User Role

admin

Request Body

FieldTypeNotes
actionstringAction: delete, new, resume, revoke, suspend.
tokensarrayTokens to act on.

Create

Create a new token.

Endpoint

HTTP
POST /token/create

Authorized User Role

admin

Request Body

FieldTypeNotes
cloudIdstringCloud ID.
descriptionstringDescription.
enablebooleanEnable.
expiresdateExpires.
rolestringAuthorized role granted by token.
typestringToken type: BuilderAPI, CloudAPI, CloudToBuilder, DeviceToCloud, ProductID.

Response

Token Record.

FieldTypeNotes
accountIdstringOwning account ID.
descriptionstringToken description.
enablebooleanToken enabled.
expiresdateToken expiration date.
idstringToken ID.
ownerstringToken owner.
rolestringToken role.
typestringToken type.

Find

Find matching tokens.

Endpoint

HTTP
POST /token/find

Authorized User Role

admin

Request Body

FieldTypeNotes
idstringToken ID.
cloudIdstringCloud ID.
enablebooleanEnable.
typestringToken type: BuilderAPI, CloudAPI, CloudToBuilder, DeviceToCloud, ProductID.

Query String Options

FieldTypeDefaultNotes
indexstringIndex name: primary or gs1.
limitnumberLimit number of results.
nextobjectToken for next page.
prevobjectToken for previous page.

Response

Paged response.

FieldTypeNotes
dataarrayA token object.
nextstringPaged cursor to use for the next page of items.
prevstringPages cursor to use for the previous page of items.

Token

FieldTypeNotes
accountIdstringOwning account ID.
descriptionstringToken description.
enablebooleanToken enabled.
expiresdateToken expiration date.
idstringToken ID.
ownerstringToken owner.
rolestringToken role.
typestringToken type.

Get

Get a token by ID.

Endpoint

HTTP
POST /token/get

Authorized User Role

admin

Request Body

FieldTypeNotes
idstringToken ID.
cloudIdstringCloud ID.
enablebooleanEnable.
typestringToken type: BuilderAPI, CloudAPI, CloudToBuilder, DeviceToCloud, ProductID.

Query String Options

FieldTypeDefaultNotes
indexstringIndex name: primary or gs1.
limitnumberLimit number of results.
nextobjectToken for next page.
prevobjectToken for previous page.

Response

Token Record.

FieldTypeNotes
accountIdstringOwning account ID.
descriptionstringToken description.
enablebooleanToken enabled.
expiresdateToken expiration date.
idstringToken ID.
ownerstringToken owner.
rolestringToken role.
typestringToken type.

Remove

Remove a token.

Endpoint

HTTP
POST /token/remove

Authorized User Role

admin

Request Body

FieldTypeNotes
cloudIdstringCloud ID.
idstringToken ID.

Update

Update a token.

Endpoint

HTTP
POST /token/update

Authorized User Role

admin

Request Body

FieldTypeNotes
cloudIdstringCloud ID.
descriptionstringDescription.
enablebooleanEnable.
expiresdateExpires.
idstringToken ID.
rolestringAuthorized role granted by token.
typestringToken type: BuilderAPI, CloudAPI, CloudToBuilder, DeviceToCloud, ProductID.

Response

Token Record.

FieldTypeNotes
accountIdstringOwning account ID.
descriptionstringToken description.
enablebooleanToken enabled.
expiresdateToken expiration date.
idstringToken ID.
ownerstringToken owner.
rolestringToken role.
typestringToken type.