CreateDcrConfigHttpInRequest

object

Payload to create an HTTP DCR provider.

* Additional properties are NOT allowed.
dcr_base_urlstring(url)required

The base URL of the DCR server. This is the URL that will be used to make the HTTP requests from Konnect to the DCR provider.
This URL must be accessible from the Konnect service.

<= 256 characters

api_keystringrequired

This is the API Key that will be sent with each HTTP request to the custom DCR server. It can be
verified on the server to ensure that incoming requests are coming from Konnect.

Match pattern:^[a-zA-Z0-9_]+$

>= 12 characters<= 256 characters

disable_event_hooksboolean

This flag disables all the event-hooks on the application flow for the DCR provider.

disable_refresh_secretboolean

This flag disable the refresh-secret endpoint on the application flow for the DCR provider.

allow_multiple_credentialsboolean

When enabled, indicates that the DCR provider supports creating and managing multiple credentials per application.

Default:false

Example

CreateDcrConfigHttpInRequest

object

Payload to update an HTTP DCR provider.

* Additional properties are NOT allowed.
dcr_base_urlstring(url)

The base URL of the DCR server. This is the URL that will be used to make the HTTP requests from Konnect to the DCR provider.
This URL must be accessible from the Konnect service.

<= 256 characters

api_keystring

This is the API Key that will be sent with each HTTP request to the custom DCR server. It can be
verified on the server to ensure that incoming requests are coming from Konnect.

Match pattern:^[a-zA-Z0-9_]+$

>= 12 characters<= 256 characters

disable_event_hooksboolean

This flag disables all the event-hooks on the application flow for the DCR provider.

disable_refresh_secretboolean

This flag disable the refresh-secret endpoint on the application flow for the DCR provider.

allow_multiple_credentialsboolean

When enabled, indicates that the DCR provider supports creating and managing multiple credentials per application.

Default:false

Example

DcrProviderBase

object

Properties common to all DCR Providers.

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

Contains a unique identifier used for this resource.

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

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

provider_typestringrequired

The type of DCR provider. Can be one of the following - auth0, azureAd, curity, okta, http

issuerstring(url)required

The issuer of the DCR provider.

<= 256 characters

activebooleanrequiredread-only

At least one active auth strategy is using this DCR provider.

dcr_configobjectrequired

The DCR configuration for this DCR provider.

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"}

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)requiredread-only

An ISO-8601 timestamp representation of entity update date.

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

Example

DCR provider - Auth0

object

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

provider_typestringrequired

Allowed values:auth0

dcr_configobjectrequired

A DCR provider configuration for Auth0

* Additional properties are NOT allowed.
Show Child Parameters
Example

DCR provider - Azure AD

object

A DCR provider for Azure AD – only properties not included in DcrProviderBase

provider_typestringrequired

Allowed values:azureAd

dcr_configobjectrequired

A DCR provider configuration for Azure AD

* Additional properties are NOT allowed.
Show Child Parameters
Example