CreateApiTokenRequest

CreateApiTokenRequest
CreateApiTokenRequest

Request to create an API token for a local console user

JSON Example
{
    "name": "string",
    "access": "string",
    "expiresInDays": 0
}
string
name
Required  
Constraints: minLength: 1 maxLength: 64

Name for the token, unique among the owner's non-revoked tokens, without control characters

access
Optional

What an API token may do, on top of its owner's role and the approved bearer routes

  • READ_ONLY: Read-only. Allows GET and HEAD on the approved read routes only
  • FULL: Full. Also allows the approved write routes, still limited by the owner's role
Enumeration: READ_ONLY, FULL
integer As int32 As int32
expiresInDays
Optional
Constraints: minimum: 1 maximum: 365 default: 90

Lifetime of the token in days, from 1 to 365; 90 when omitted