Skip to main content
POST
Create a System Access Token

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

The name of the token.

Required string length: 1 - 256
permissions
object[] | null

The permissions to grant. Omit this to get the default set — read and write on the resources a platform user normally works with.

expires_at

When the token should expire. Accepts either an RFC 3339 timestamp or a bare YYYY-MM-DD date, which is read as midnight UTC.

The gap between now and this value must be at least 1 and at most 365 whole days — a value less than 24 hours out rounds down to 0 days and is rejected. Omit it to get the maximum, 365 days.

Pattern: ^\d{4}-\d{2}-\d{2}T
Example:

"2023-10-31T11:19:13.400498Z"

Response

The token was created. This is the only response that contains access_token.

A newly created System Access Token. This is the only response that carries access_token — store it now, because no later call returns it and there is no way to recover it.

id
string<uuid>
required

The id of the token.

name
string
required

The name of the token.

permissions
object[]
required

The permissions granted to the token.

expires_at
string<date-time>
required

When the token expires, RFC 3339. Expiry is stored with day granularity, so this is the requested expiry rounded down to a whole number of days from when the token was created — ask for 36 hours and you get 24.

Example:

"2023-10-31T11:19:13.400498Z"

access_token
string
required

The credential, base64-encoded. Send it as Authorization: Bearer <access_token>.