Create DCR provider
Creates a DCR provider.
Body
application/json
Body
CreateDcrProviderRequest
Request body for creating a DCR provider. The provider_type cannot be updated after creation.
One OfAllowed values:auth0
Payload to create an Auth0 DCR provider.
Show Child Parameters
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.
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 DCR provider object.
CreateDcrProviderResponse
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
Body
List DCR Providers
Returns a paginated collection of DCR providers.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Sorts a collection of DCR Providers. Supported sort attributes are:
- created_at
- updated_at
- provider_type
- issuer
- name
filters DCR Providers by their id
filters DCR Providers by their id (alias for filter[id][eq])
filters DCR Providers by their id with a supplied substring
filters DCR Providers by their issuer
filters DCR Providers by their issuer (alias for filter[issuer][eq])
filters DCR Providers by their issuer with a supplied substring
filters DCR Providers by their name
filters DCR Providers by their name (alias for filter[name][eq])
filters DCR Providers by their name with a supplied substring
filters DCR Providers by their provider type
filters DCR Providers by their provider type (alias for filter[provider_type][eq])
filters DCR Providers by their initial client id
filters DCR Providers by their initial client id (alias for filter[initial_client_id][eq])
filters DCR Providers by their initial client id with a supplied substring
filters DCR Providers by their initial client audience
filters DCR Providers by their initial client audience (alias for filter[initial_client_audience][eq])
filters DCR Providers by their initial client audience with a supplied substring
Response
application/json
Response
A paginated list response for a collection of DCR providers
ListDcrProvidersResponse
A paginated list response for a collection of DCR providers
One OfA DCR provider for Auth0 – only properties not included in DcrProviderBase
Show Child Parameters
returns the pagination information
Show Child Parameters
Query Parameters
Get a DCR provider
Returns a DCR provider.
Path Parameters
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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
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.