Update personal access token details

Update personal access token details.

patch
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

Body

application/json

Request body schema for updating personal access tokens.

namestring

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

>= 1 characters<= 256 characters

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

patch/users/{userId}/access-tokens/{tokenId}

Body

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

Delete personal access token

Delete personal access token.

delete
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

No Content

delete/users/{userId}/access-tokens/{tokenId}
 

Revoke Personal Access Token

Revoke Personal Access Token.

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

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

patch/users/{userId}/access-tokens/{tokenId}/revoke
 
application/json

IdentityProviderType

string

Specifies the type of identity provider.

Allowed values:oidcsaml

Example

Identity Provider Login Path Property

string

The path used for initiating login requests with the identity provider.

Example