Update Impersonation Settings

Updates Impersonation Settings.

patch
https://global.api.konghq.com/v3/organizations/impersonation

Body

application/json

The request schema for adding a system account to a team.

enabledboolean

Indicates if user impersonation is allowed for the organization.

Example:true

Response

application/json

Response for Update Impersonation Settings endpoint

Update Impersonation Settings Response

enabledboolean

The organization has user impersonation enabled.

Example:true

patch/organizations/impersonation

Body

{ "enabled": false }
 
application/json

Personal Access Tokens

List PATs

List personal access tokens for a user.

get
https://global.api.konghq.com/v3/users/{userId}/access-tokens

Path Parameters

userIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Response

application/json

A list response for a collection of personal access tokens.

* Additional properties are NOT allowed.
metaobject

Contains pagination query parameters and the total number of objects returned.

Show Child Parameters
dataarray[object]required

Properties of a personal access token.

* Additional properties are NOT allowed.
Show Child Parameters
get/users/{userId}/access-tokens
 
application/json

Create a new personal access token

Create a new personal access token. A maximum of 10 personal access tokens can be created.

post
https://global.api.konghq.com/v3/users/{userId}/access-tokens

Path Parameters

userIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Body

application/json

Request body schema for creating personal access tokens.

One Of
namestringrequired

Match pattern:^[\p{L}\p{N}][\p{L}\p{N} _\-\.']*[\p{L}\p{N}]$

>= 1 characters<= 256 characters

expires_atstring(date-time)required

An ISO-8601 timestamp representation of entity expiration date.

Example:2022-11-04T20:10:06.927Z

Response

application/json

Response containing details of the created personal access token.

PersonalAccessTokenCreateResponse

Details of the created personal access token.

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

user_idstring(uuid)requiredread-only

Contains a unique identifier used for a user.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired
statestringrequiredread-only

State of the personal access token.

Allowed values:ACTIVEREVOKEDEXPIRED

konnect_tokenstringrequired

The Konnect token used to authenticate with Konnect.

revoked_bystring | null(uuid)read-only

Contains a unique identifier used for the user that revoked this token.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

last_used_atstring | null(date-time)read-only

An ISO-8601 timestamp representation of entity last used date.

Example:2022-11-04T20:10:06.927Z

expires_atstring | null(date-time)requiredread-only

An ISO-8601 timestamp representation of entity expiration date.

Example:2022-11-04T20:10:06.927Z

revoked_atstring | null(date-time)read-only

An ISO-8601 timestamp representation of entity revoked at date.

Example:2022-11-04T20:10:06.927Z

post/users/{userId}/access-tokens

Body

{ "name": "Token", "expires_at": "2024-01-01T00:00:00.000Z" }
 
application/json

Get Personal Access Token details

Get Personal Access Token details.

get
https://global.api.konghq.com/v3/users/{userId}/access-tokens/{tokenId}

Path Parameters

userIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

tokenIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Response

application/json

Response containing details of a personal access token.

PersonalAccessToken

Properties of a personal access token.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

user_idstring(uuid)requiredread-only

Contains a unique identifier used for a user.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired
statestringrequired

State of the personal access token.

Allowed values:ACTIVEREVOKEDEXPIRED

revoked_bystring | null(uuid)read-only

Contains a unique identifier used for the user that revoked this token.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

last_used_atstring | null(date-time)read-only

An ISO-8601 timestamp representation of entity last used date.

Example:2022-11-04T20:10:06.927Z

expires_atstring | null(date-time)requiredread-only

An ISO-8601 timestamp representation of entity expiration date.

Example:2022-11-04T20:10:06.927Z

revoked_atstring | null(date-time)read-only

An ISO-8601 timestamp representation of entity revoked at date.

Example:2022-11-04T20:10:06.927Z

get/users/{userId}/access-tokens/{tokenId}
 
application/json