Update DCR provider
Updates a DCR provider.
Path Parameters
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Body
application/json
Body
UpdateDcrProviderRequest
A set of updates to a DCR provider. The provider_type cannot be updated after creation.
The name of the DCR provider. This is used to identify the DCR provider in the Konnect UI.
>= 1 characters<= 256 characters
The display name of the DCR provider. This is used to identify the DCR provider in the Portal UI.
>= 1 characters<= 256 characters
<= 256 characters
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"}
Any OfPayload to update an Auth0 DCR provider.
Show Child Parameters
Response
application/json
Response
A response containing a single DCR provider object. Sensitive fields will be removed from the response.
DcrProviderResponse
One OfContains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The name of the DCR provider. This is used to identify the DCR provider in the Konnect UI.
>= 1 characters<= 256 characters
The display name of the DCR provider. This is used to identify the DCR provider in the Portal UI.
>= 1 characters<= 256 characters
The type of DCR provider. Can be one of the following - auth0, azureAd, curity, okta, http
Allowed values:auth0
The issuer of the DCR provider.
<= 256 characters
At least one active auth strategy is using this DCR provider.
A DCR provider configuration for Auth0
Show Child Parameters
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"}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Path Parameters
Body
Delete DCR provider
Deletes a DCR provider.
Path Parameters
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
Response
No Content.
Path Parameters
Verify DCR provider configuration
Verifies if a DCR provider is configured properly. Returns 200 for success, 4xx for failure.
Path Parameters
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
application/json
Response
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.
Allowed values:successfailed
Path Parameters
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.
Body
application/json
Body
CreateAppAuthStrategyRequest
Request body for creating an Application Auth Strategy
One OfThe name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.
>= 1 characters<= 256 characters
The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.
<= 256 characters
Allowed values:key_auth
JSON-B object containing the configuration for the Key Auth strategy
Show Child Parameters
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
Response
A response containing the newly created application auth strategy object.
CreateAppAuthStrategyResponse
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 OfContains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.
>= 1 characters<= 256 characters
The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.
<= 256 characters
Allowed values:key_auth
JSON-B object containing the configuration for the Key Auth strategy
Show Child Parameters
At least one published entity is using this auth strategy.
Show Child Parameters
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"}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Indicates whether this auth strategy supports multiple credentials.
Always true for KEY_AUTH.
Default:true