Sign in

v1

latestOpenAPI 3.1.0AGPL-3.02026-07-1249126143.7 KB
Admin API token

Updates information about the specified admin API token.

post/v2/UpdateAdminToken

Query parameters

idstring required

Admin API token ID

Request body

expirationstring date-time nullable

Expiration time and date, formatted according to RFC 3339

namestring nullable

Name of the admin API token

neverExpiresboolean

Set the admin token to never expire

scopestring[] nullable

Scope of the admin API token, a list of admin endpoint names (such as GetClusterStatus, etc), or the special value * to allow all admin endpoints. WARNING: Granting a scope of CreateAdminToken or UpdateAdminToken trivially allows for privilege escalation, and is thus functionally equivalent to granting a scope of *.

Response

Admin token has been updated

createdstring date-time nullable

Creation date

expirationstring date-time nullable

Expiration time and date, formatted according to RFC 3339

expiredboolean required

Whether this admin token is expired already

idstring nullable

Identifier of the admin token (which is also a prefix of the full bearer token)

namestring required

Name of the admin API token

scopestring[] required

Scope of the admin API token, a list of admin endpoint names (such as GetClusterStatus, etc), or the special value * to allow all admin endpoints