TooManyRequestsError
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:429
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:Too Many Requests
The error type.
Example:https://httpstatuses.com/429
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:1234567890
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:Too Many Requests
UpdateApplicationPayload
objectPayload required to update an application
The name of the application
<= 255 characters
An identifier to correlate the application with an external system.
Cannot be set when using Dynamic Client Registration.
<= 255 characters
URL to redirect to after completing an OIDC auth flow
A brief description of the application
<= 255 characters
The granted scopes for the application. Will only be included if supported by the application’s auth strategy.
ApplicationUpdateResponse
objectApplication update response payload
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An identifier to correlate the application with an external system.
Cannot be set when using Dynamic Client Registration.
<= 255 characters
Example:A brief description of the application
Example:https://example.com/callback
One OfKeyAuth Auth strategy that the application uses.
Show Child Parameters
The granted scopes for the application. Will only be included if supported by the application’s auth strategy.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Refresh token response
objectRefresh token response
ApiKeyCredentialListItem
objectAPI key credential returned when listing credentials.
Allowed values:api_key
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Allowed values:activeexpiredrevoked
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z