Get a System Account

Returns the system account (SA) for the SA ID specified as a path parameter.

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

Path Parameters

accountIdstringrequired

ID of the system account.

Response

application/json

A response including a single system account.

System Account

Schema of the system account.

idstring(uuid)read-only

ID of the system account.

namestring

Name of the system account.

descriptionstring

Description of the system account.

created_atstring(date-time)read-only

Timestamp of when the system account was created.

updated_atstring(date-time)read-only

Timestamp of when the system account was last updated.

konnect_managedboolean

The system account is managed by Konnect (true/false).

get/system-accounts/{accountId}
 
application/json

Update System Account

Updates the specified system account. Returns a 409 if the updated name is the same as another system account in the organization.

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

Path Parameters

accountIdstringrequired

ID of the system account.

Body

application/json

The request schema for the update system account request.

namestring

Name of the system account.

descriptionstring

Description of the system account.

Response

application/json

A response including a single system account.

System Account

Schema of the system account.

idstring(uuid)read-only

ID of the system account.

namestring

Name of the system account.

descriptionstring

Description of the system account.

created_atstring(date-time)read-only

Timestamp of when the system account was created.

updated_atstring(date-time)read-only

Timestamp of when the system account was last updated.

konnect_managedboolean

The system account is managed by Konnect (true/false).

patch/system-accounts/{accountId}

Body

{}
 
application/json

Delete System Account

Deletes the specified system account. Returns 404 if the requested account was not found.

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

Path Parameters

accountIdstringrequired

ID of the system account.

Response

No Content

delete/system-accounts/{accountId}
 

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.

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

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filter access tokens 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 system accounts access tokens.

System Account Access Token Collection Reponse

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

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
get/system-accounts/{accountId}/access-tokens
 
application/json