AccessToken

See authentication for an explanation of how to use Access Tokens.

{
    "accessToken": "i0gni52qmhtdsht5pvpu68dv96gqvil6",
    "clientName": "My Client App",
    "creationDate": 1691017391046,
    "creator": null,
    "enterpriseName": "myenterprise",
    "expirationDate": 1692226991046,
    "roles": [ "ROLE_READONLY", "ROLE_READWRITE" ],
    "seamId": null
}

Properties

accessToken

Use this token string in API requests.

clientDeviceType

The client device type. Can be; "IOS_NATIVE", "IOS", "ANDROID", "MOBILE", "TABLET", "NORMAL", "UNKNOWN"

clientName

Client-supplied name of the client that requested the token.

creationDate

When the token was created.

creator

The creator (typically a username) of this access token

enterpriseName

The name of the Enterprise to which this access token grants access.

expirationDate

When the token will expire. By default, tokens expire after two weeks.

firstName

The first name of the user.

lastName

The last name of the user.

pairingCodeEndpointId

The endpoint id for the pairing code.

pairingCodeId

The pairing code id.

roles

List of permissions that this token grants on the Enterprise. ROLE_READONLY lets you read provisioning data and control Endpoints. ROLE_READWRITE lets you create, edit, and delete provisioning data.ROLE_PAIRINGCODE gives you Zero Touch access.

seamId

The Seam ID of the enterprise.

username

The username of the user.