System Accounts - Access Tokens
List System Account Access Tokens
Returns the access tokens for the specified system account. Returns 400 if any filter parameters are invalid.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filter access tokens returned in the response.
Show Child Parameters
Path Parameters
ID of the system account.
Response
application/json
Response
A paginated list response for a collection of system accounts access tokens.
System Account Access Token Collection Reponse
returns the pagination information
Show Child Parameters
Schema of the system account access token.
Example:{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"Sample Access Token","created_at":"2022-08-01T14:16:09Z","updated_at":"2022-08-02T08:35:49Z","expires_at":"2022-12-31T12:52:23Z","last_used_at":"2022-10-24T13:05:42Z"}
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Create System Account Access Token
Creates an access token for the specified system account (SA). The access token can be used for authenticating API and CLI requests. The token will only be displayed once on creation. Returns a 409 if the system account already has a token with the same name.
Path Parameters
ID of the system account.
Body
application/json
Body
The request body to create a system account access token.
Response
application/json
Response
A response including a single system account access token with the token.
System Account Access Token Created Response
ID of the system account access token.
Name of the system account access token.
Timestamp of when the system account access token was created.
Timestamp of when the system account access token was last updated.
Timestamp of when the system account access token will expire.
Timestamp of when the system account access token was last used.
The token of the system account access token.
Authentication
Path Parameters
Body
Get a System Account Access Token
Returns the system account (SA) access token for the SA Access Token ID specified as a path parameter.
Path Parameters
ID of the system account.
ID of the system account access token.
Response
application/json
Response
A response including a single system account access token.
System Account Access Token
Schema of the system account access token.
ID of the system account access token.
Name of the system account access token.
Timestamp of when the system account access token was created.
Timestamp of when the system account access token was last updated.
Timestamp of when the system account access token will expire.
Timestamp of when the system account access token was last used.
Authentication
Path Parameters
Update System Account Access Token
Updates the specified access token. Returns a 409 if the updated name is the same as another token belonging to the specified system user.
Path Parameters
ID of the system account.
ID of the system account access token.
Body
application/json
Body
Name of the system account access token.
Response
application/json
Response
A response including a single system account access token.
System Account Access Token
Schema of the system account access token.
ID of the system account access token.
Name of the system account access token.
Timestamp of when the system account access token was created.
Timestamp of when the system account access token was last updated.
Timestamp of when the system account access token will expire.
Timestamp of when the system account access token was last used.