Create api token

Create a new api token for this user. This token can be used to authenticate against the API. The token has the same privileges as the current user account, assigned to tenant.

^{Required permissions: user:api-token:write}

POST /user/api-tokens

cURL

cURL

curl -X POST \
 /user/api-tokens \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "description": "My API token",
    "expiresAt": "2021-01-01T00:00:00+00:00"
}'

201

{
  "id": "A1B2C3D4E5F6G7H8I9J0",
  "token": "api_A1B2C3D4E5F6G7H8I9J0",
  "description": "My API token",
  "expiresAt": "2021-01-01T00:00:00+00:00"
}

Autorisierungen

Authorization · string · header · erforderlich

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

Body

application/jsontext/html

The new ApiToken resource

description · string | null

Description of the API token

Required string length: 3 - 255

Beispiel:

"My API token"

expiresAt · string<date-time> | null

Date and time when the API token expires. If null, the token never expires.

Beispiel:

"2021-01-01T00:00:00+00:00"

Antwort

201

application/json

ApiToken resource created

id · string

Beispiel:

"A1B2C3D4E5F6G7H8I9J0"

token · string

Beispiel:

"api_A1B2C3D4E5F6G7H8I9J0"

description · string | null

Beispiel:

"My API token"

expiresAt · string<date-time> | null

Beispiel:

"2021-01-01T00:00:00+00:00"