Update DCR provider

Updates a DCR provider.

patch

Path Parameters

dcrProviderIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

Body

application/json

UpdateDcrProviderRequest

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 | null

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

Response

application/json

A response containing a single DCR provider object. Sensitive fields will be removed from the response.

DcrProviderResponse

DcrProviderResponse
One Of
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

Allowed values:auth0

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

A DCR provider configuration for Auth0

* Additional properties are NOT allowed.
Show Child Parameters
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

patch/dcr-providers/{dcrProviderId}

Body

{ "name": "DCR Okta 1 - Segment A", "issuer": "https://my-issuer.okta.com/default" }
 
application/json

Delete DCR provider

Deletes a DCR provider.

delete

Path Parameters

dcrProviderIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

Response

No Content.

delete/dcr-providers/{dcrProviderId}
 

Verify DCR provider configuration

Verifies if a DCR provider is configured properly. Returns 200 for success, 4xx for failure.

post

Path Parameters

dcrProviderIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

Response

application/json

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

VerifyDcrProviderResponse

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
post/dcr-providers/{dcrProviderId}/verify
 
application/json

App Auth Strategies

Application Auth Strategies are sets of plugin configurations that represent how the gateway will perform authentication and authorization for a Product Version.
Called “Auth Strategy” for short in the context of portals/applications.
The plugins are synced to any Gateway Service that is currently linked or becomes linked to the Product Version.

Create App Auth Strategy

Creates an application auth strategy.

post

Body

application/json

CreateAppAuthStrategyRequest

CreateAppAuthStrategyRequestobject

Request body for creating an Application Auth Strategy

One Of
namestringrequired

The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.

>= 1 characters<= 256 characters

display_namestringrequired

The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.

<= 256 characters

strategy_typestringrequired

Allowed values:key_auth

configsobjectrequired

JSON-B object containing the configuration for the Key Auth strategy

* Additional properties are NOT allowed.
Show Child Parameters
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"}

Response

application/json

A response containing the newly created application auth strategy object.

CreateAppAuthStrategyResponse

CreateAppAuthStrategyResponseobject

A set of plugin configurations that represent how the gateway will perform authentication and authorization for a Product Version. Called “Auth Strategy” for short in the context of portals/applications. The plugins are synced to any Gateway Service that is currently linked or becomes linked to the Product Version.

One Of
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

namestringrequired

The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.

>= 1 characters<= 256 characters

display_namestringrequired

The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.

<= 256 characters

strategy_typestringrequired

Allowed values:key_auth

configsobjectrequired

JSON-B object containing the configuration for the Key Auth strategy

* Additional properties are NOT allowed.
Show Child Parameters
activebooleanrequired

At least one published entity is using this auth strategy.

dcr_providerobject | nullrequired
* Additional properties are NOT allowed.
Show Child Parameters
labelsobjectrequired

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

supports_multiple_credentialsbooleanread-only

Indicates whether this auth strategy supports multiple credentials.
Always true for KEY_AUTH.

Default:true

post/application-auth-strategies

Body

{ "name": "auth strategy 1", "display_name": "API Key Auth", "strategy_type": "key_auth", "configs": { "key-auth": { "key_names": [ "apikey", "api-key", "x-api-key" ] } } }
 
application/json