v3

latestOpenAPI 3.0.12026-07-314655871.8 MB
Users

Update an existing access token

put/access_token/{token_prefix}

Path parameters

token_prefixstring required

Access token prefix

Request body

descriptionstring required

Name / description of an access token

Response

Response

create_timestring required

Timestamp when the access token was created

created_manuallyboolean

True for tokens explicitly created via the access_tokens API, false for tokens created via login.

currently_activeboolean

true if API request was made with this access token

descriptionstring

Name / description of an access token

expiry_timestring

Timestamp when the access token will expire unless extended, if ever

extend_when_usedboolean required

Extend token expiration time when token is used. Only applicable if max_age_seconds is specified.

ip_allowliststring[]

List of allowed IP ranges

last_ipstring

IP address the access token was last used from in case it has ever been used

last_used_timestring

Timestamp when the access token was last used, if ever

last_user_agentstring

User agent string of the client that last used the token in case it has ever been used

last_user_agent_human_readablestring

Human readable user agent string of the client that last used the token in case user agent is known

max_age_secondsnumber required

Time the token remains valid since creation (or since last use if extend_when_used is true)

messagestring

Printable result of the request

scopesstring[]

Scopes this token is restricted to, if specified

token_prefixstring required

First characters of the actual token value. Full value is only exposed after creation. This value is used when updating or revoking tokens. Note that the value may contain /, + and = characters and must be URL encoded when used (/ => %2F, + => %2B, = => %3D).