PATName

string

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

>= 1 characters<= 256 characters

PersonalAccessTokenCreateRequestWithExpiresAt

object

Deprecated: Use ttl_seconds instead of expires_at to specify token expiration. Using a time-to-live value avoids clock skew issues when setting token expiration.

* Additional properties are NOT allowed.
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

Example

PersonalAccessTokenCreateRequestWithTTL

object
* Additional properties are NOT allowed.
namestringrequired

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

>= 1 characters<= 256 characters

ttl_secondsintegerrequired

The time to live in seconds for the personal access token.

>= 86400<= 31536000

Example

PersonalAccessTokenCreateResponse

object

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(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(date-time)read-only

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

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

expires_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity expiration date.

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

revoked_atstring(date-time)read-only

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

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

Example

Error

object

standard error

statusintegerrequiredread-only

The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.

titlestringrequiredread-only

A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.

typestringread-only

The error type.

instancestringrequiredread-only

Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.

detailstringrequiredread-only

A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.

Example