AvailableScopes

array

Possible developer selectable scopes for an application. Only present when using DCR Provider that supports it.

Example

AuthStrategyClientCredentials

object

Client Credential Auth strategy that the application uses.

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

The Application Auth Strategy ID.

Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8

namestringrequired

Default:name

Example:name

credential_typestringrequired

Allowed values:client_credentialsself_managed_client_credentials

auth_methodsarray[string]required

Auth Methods enabled for this strategy

Example:bearer

available_scopesarray[string]

Possible developer selectable scopes for an application. Only present when using DCR Provider that supports it.

Example:scope1, scope2

Example

AuthStrategy

object
One Of
idstring(uuid)requiredread-only

The Application Auth Strategy ID.

Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8

namestringrequired

Default:name

Example:name

credential_typestringrequired

Allowed values:key_auth

key_namesarray[string]required
ttlobject

Default maximum Time-To-Live for keys created under this strategy.

Show Child Parameters
Example

API Spec Type

string

The type of specification being stored. This allows us to render the specification correctly.

Allowed values:oas2oas3asyncapi

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