Get a System Account Access Token

Returns the system account (SA) access token for the SA Access Token ID specified as a path parameter.

get
https://global.api.konghq.com/v3/system-accounts/{accountId}/access-tokens/{tokenId}

Path Parameters

accountIdstringrequired

ID of the system account.

tokenIdstringrequired

ID of the system account access token.

Response

application/json

A response including a single system account access token.

System Account Access Token

Schema of the system account access token.

idstring(uuid)read-only

ID of the system account access token.

namestring

Name of the system account access token.

created_atstring(date-time)read-only

Timestamp of when the system account access token was created.

updated_atstring(date-time)read-only

Timestamp of when the system account access token was last updated.

expires_atstring(date-time)

Timestamp of when the system account access token will expire.

last_used_atstring(date-time)read-only

Timestamp of when the system account access token was last used.

get/system-accounts/{accountId}/access-tokens/{tokenId}
 
application/json

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.

patch
https://global.api.konghq.com/v3/system-accounts/{accountId}/access-tokens/{tokenId}

Path Parameters

accountIdstringrequired

ID of the system account.

tokenIdstringrequired

ID of the system account access token.

Body

application/json
namestringrequired

Name of the system account access token.

Response

application/json

A response including a single system account access token.

System Account Access Token

Schema of the system account access token.

idstring(uuid)read-only

ID of the system account access token.

namestring

Name of the system account access token.

created_atstring(date-time)read-only

Timestamp of when the system account access token was created.

updated_atstring(date-time)read-only

Timestamp of when the system account access token was last updated.

expires_atstring(date-time)

Timestamp of when the system account access token will expire.

last_used_atstring(date-time)read-only

Timestamp of when the system account access token was last used.

patch/system-accounts/{accountId}/access-tokens/{tokenId}

Body

{ "name": "name" }
 
application/json

Delete System Account Access Token

Deletes the specified token. Returns 404 if the token was not found.

delete
https://global.api.konghq.com/v3/system-accounts/{accountId}/access-tokens/{tokenId}

Path Parameters

accountIdstringrequired

ID of the system account.

tokenIdstringrequired

ID of the system account access token.

Response

No Content

delete/system-accounts/{accountId}/access-tokens/{tokenId}
 

System Accounts - Roles

List Assigned Roles for System Account

Lists the roles belonging to a system account. Returns 400 if any filter parameters are invalid.

get
https://global.api.konghq.com/v3/system-accounts/{accountId}/assigned-roles

Query Parameters

filterobject

Filter roles returned in the response.

Show Child Parameters

Path Parameters

accountIdstringrequired

ID of the system account.

Response

application/json

A paginated list response for a collection of assigned roles.

Assigned Role Collection Response

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

An assigned role is a role that has been assigned to a user or team.

Example:{"id":"54cc6168-ebb1-4300-8168-d62a0dd08fc8","role_name":"Viewer","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Control Planes","entity_region":"us"}

Show Child Parameters
get/system-accounts/{accountId}/assigned-roles
 
application/json