UpdateDcrProviderRequest

object

Updates a DCR provider.

idstring(uuid)required
org_idstring(uuid)required
namestringrequired

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

>= 1 characters<= 256 characters

provider_typestringrequired

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

Allowed values:auth0azureAdcurityoktahttpkongIdentity

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.

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
required
DcrConfigAuth0InRequestobject

Payload to update an Auth0 DCR provider.

* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)required
updated_atstring(date-time)required
Example

DcrProvider

object
idstring(uuid)required
org_idstring(uuid)required
namestringrequired

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

>= 1 characters<= 256 characters

provider_typestringrequired

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

Allowed values:auth0azureAdcurityoktahttpkongIdentity

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.

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
required
DcrConfigAuth0InRequestobject

Payload to update an Auth0 DCR provider.

* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)required
updated_atstring(date-time)required
Example

DcrProviderName

string

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

>= 1 characters<= 256 characters

DcrBaseUrl

string

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

DcrConfigAuth0InRequest

object

Payload to update an Auth0 DCR provider.

* Additional properties are NOT allowed.
initial_client_idstring

This ID should be copied from your identity provider’s settings after you create a client
and assign it as the management client for DCR for this developer portal

<= 256 characters

initial_client_secretstring

This secret should be copied from your identity provider’s settings after you create a client
and assign it as the management client for DCR for this developer portal

initial_client_audiencestring

This is the audience value used for the initial client.
If using a custom domain on Auth0, this must be set as to the Auth0 Management API audience value.
If left blank, the issuer will be used instead.

<= 256 characters

use_developer_managed_scopesboolean
Example