CreateDcrProviderRequest

object

Request body for creating a DCR provider. The provider_type cannot be updated after creation.

One Of
provider_typestringrequired

Allowed values:auth0

dcr_configobjectrequired

Payload to create an Auth0 DCR provider.

* Additional properties are NOT allowed.
Show Child Parameters
namestringrequired

The name of the DCR provider. This is used to identify the DCR provider in the Konnect UI.

>= 1 characters<= 256 characters

display_namestring

The display name of the DCR provider. This is used to identify the DCR provider in the Portal UI.

>= 1 characters<= 256 characters

issuerstring(url)required

<= 256 characters

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

Example

UpdateDcrProviderRequest

object

A set of updates to a DCR provider. The provider_type cannot be updated after creation.

* Additional properties are NOT allowed.
namestring

The name of the DCR provider. This is used to identify the DCR provider in the Konnect UI.

>= 1 characters<= 256 characters

display_namestring

The display name of the DCR provider. This is used to identify the DCR provider in the Portal UI.

>= 1 characters<= 256 characters

issuerstring(url)

<= 256 characters

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Labels are intended to store INTERNAL metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

dcr_configAny Of
DcrConfigAuth0InRequestobject

Payload to update an Auth0 DCR provider.

* Additional properties are NOT allowed.
Show Child Parameters
Example

ListDcrProvidersResponse

object

A paginated list response for a collection of DCR providers

* Additional properties are NOT allowed.
dataOne Of
array[object]required
DCR provider - Auth0object

A DCR provider for Auth0 – only properties not included in DcrProviderBase

* Additional properties are NOT allowed.
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
Example

VerifyDcrProviderResponse

object

A response containing the result of attempting to verify a DCR provider configuration.

* Additional properties are NOT allowed.
statusstringrequired

Allowed values:successfailed

errorsarray[string]required
Example

AppAuthStrategyConfigKeyAuth

object

The most basic mode to configure an Application Auth Strategy for an API Product Version.
Using this mode will allow developers to generate API keys that will authenticate their application requests.
Once authenticated, an application will be granted access to any Product Version it is registered for that is configured for Key Auth.

* Additional properties are NOT allowed.
key_namesarray[string]

The names of the headers containing the API key. You can specify multiple header names.

<= 256 characters>= 1 items<= 10 items

ttlobject

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

Show Child Parameters
Example