Skip to main content
GET
Get an API token

Authorizations

Authorization
string
header
required

Bearer token for the authenticated caller.

Path Parameters

id
string
required
Required string length: 3 - 54

Response

Token metadata

id
string
required
Required string length: 3 - 54
name
string
required
Required string length: 1 - 100
Example:

"My CLI token"

prefix
string
required

The first 12 characters of the token, for recognizing it. Never the secret.

Example:

"sk_akua_a3B2"

workspace_id
string | null
required

The only Workspace the token may act in. Omitted or null: every Workspace the person may use.

Required string length: 2 - 53
roles
object | null
required

A ceiling of IAM roles: the token may do only what one of these roles includes, and only what the person may. Omitted or null: the rights of the person.

created_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
last_used_at
integer | null
required

Unix timestamp (seconds) of last use, or null if never used

Required range: x >= 0
expires_at
integer | null
required

Unix timestamp (seconds) when the token expires, or null if never

Required range: x >= 0