CredentialCreationResponse

object
One Of
typestringrequiredread-only

Allowed values:api_key

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

display_namestringrequired
credentialstringrequired

The API key value (only returned on creation)

statusstringread-only

Allowed values:activeexpiredrevoked

expires_atstring(date-time)read-only
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

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

Example

UpdateCredentialRequest

object
* Additional properties are NOT allowed.
display_namestringrequired

<= 255 characters

Example

RefreshedGrantedScopes

array

List of granted scopes, directly updated from the IDP

GetGrantedScopesAPIResponse

object
* Additional properties are NOT allowed.
scopesarray[string]required

List of granted scopes, directly updated from the IDP

Example

UnprocessableContentError

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.

Example:422

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.

Example:Unprocessable Content

typestringread-only

The error type.

Example:https://httpstatuses.com/422

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.

Example:kong:trace:1234567891

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:Unprocessable Content

Example