Kong DCR Providers API is one of 139 APIs that Kong publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include DCR Providers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.
This API exposes
6 operations
across 3 paths,
and defines 62 schemas.
It is described by OpenAPI 3.1.0, at version 3.14.0.
Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.
The identity and technical contract details declared by the specification.
CreateDcrConfigAuth0InRequest
object
Payload to create an Auth0 DCR provider.
4 properties
2 required
CreateDcrProviderRequestAuth0
object
Request body for creating an Auth0 DCR provider.
6 properties
4 required
CreateDcrConfigHttpInRequest
object
Payload to create an HTTP DCR provider.
5 properties
2 required
InvalidParameterChoiceItem
object
5 properties
4 required
CreateDcrProviderResponse
object
A response containing the newly created DCR provider object.
VerifyDcrProviderResponse
object
A response containing the result of attempting to verify a DCR provider configuration.
2 properties
2 required
Labels
object
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,…
UpdateDcrConfigHttpInRequest
object
Payload to update an HTTP DCR provider.
5 properties
DcrProviderCurity
object
A DCR provider for Curity -- only properties not included in DcrProviderBase
2 properties
2 required
DcrProviderOkta
object
A DCR provider for Okta -- only properties not included in DcrProviderBase
2 properties
2 required
CreateDcrProviderRequest
object
Request body for creating a DCR provider. The providertype cannot be updated after creation.
DcrConfigHttpInResponse
object
A DCR provider configuration for HTTP
4 properties
1 required
UpdateDcrConfigAuth0InRequest
object
Payload to update an Auth0 DCR provider.
4 properties
InvalidParameterMinimumLength
object
5 properties
4 required
UpdateDcrConfigOktaInRequest
object
Payload to update an Okta DCR provider.
1 property
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
InvalidParameterMaximumLength
object
5 properties
4 required
CreateDcrProviderRequestOkta
object
Request body for creating an Okta DCR provider.
6 properties
4 required
DcrConfigPropertyInitialClientAudience
string
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 l…
ListDcrProvidersResponse
object
A paginated list response for a collection of DCR providers
2 properties
2 required
DcrProviderAzureAd
object
A DCR provider for Azure AD -- only properties not included in DcrProviderBase
2 properties
2 required
LabelsUpdate
object
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 me…
DcrConfigOktaInResponse
object
A DCR provider configuration for Okta
PaginatedMeta
object
returns the pagination information
1 property
1 required
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
BaseError
object
standard error
5 properties
4 required
DcrProviderName
string
The name of the DCR provider. This is used to identify the DCR provider in the Konnect UI.
UpdateDcrConfigAzureAdInRequest
object
Payload to update an Azure AD DCR provider.
2 properties
DcrConfigPropertyApiKey
string
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 co…
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…
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties
3 required
DcrConfigPropertyDisableEventHooks
boolean
This flag disables all the event-hooks on the application flow for the DCR provider.
DcrConfigCurityInResponse
object
A DCR provider configuration for Curity
1 property
1 required
DcrProviderHttp
object
A DCR provider for HTTP -- only properties not included in DcrProviderBase
2 properties
2 required
UUID
string
Contains a unique identifier used for this resource.
DcrProviderAuth0
object
A DCR provider for Auth0 -- only properties not included in DcrProviderBase
2 properties
2 required
CreateDcrProviderRequestCurity
object
Request body for creating a Curity DCR provider.
6 properties
4 required
DcrConfigAzureAdInResponse
object
A DCR provider configuration for Azure AD
1 property
1 required
DcrConfigPropertyDcrToken
string
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…
CreateDcrConfigCurityInRequest
object
Payload to create a Curity DCR provider.
2 properties
2 required
InvalidRules
string
invalid parameters rules
CreateDcrProviderRequestHttp
object
Request body for creating an HTTP DCR provider.
6 properties
4 required
InvalidParameters
array
invalid parameters
CreateDcrConfigAzureAdInRequest
object
Payload to create an Azure AD DCR provider.
2 properties
2 required
UpdateDcrProviderRequest
object
A set of updates to a DCR provider. The providertype cannot be updated after creation.
5 properties
DcrConfigPropertyDisableRefreshSecret
boolean
This flag disable the refresh-secret endpoint on the application flow for the DCR provider.
DcrProviderBase
object
Properties common to all DCR Providers.
10 properties
8 required
DcrConfigPropertyAllowMultipleCredentials
boolean
When enabled, indicates that the DCR provider supports creating and managing multiple credentials per application.
DcrConfigPropertyInitialClientId
string
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 por…
CreateDcrConfigOktaInRequest
object
Payload to create an Okta DCR provider.
1 property
1 required
CreateDcrProviderRequestAzureAd
object
Request body for creating an Azure AD DCR provider.
6 properties
4 required
UpdateDcrConfigCurityInRequest
object
Payload to update a Curity DCR provider.
2 properties
DcrProviderDisplayName
string
The display name of the DCR provider. This is used to identify the DCR provider in the Portal UI.
InvalidParameterDependentItem
object
5 properties
4 required
DcrProviderResponse
object
A response containing a single DCR provider object. Sensitive fields will be removed from the response.
InvalidParameterStandard
object
4 properties
2 required
DcrConfigAuth0InResponse
object
A DCR provider configuration for Auth0
3 properties
3 required
DcrConfigPropertyInitialClientSecret
string
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…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Kong publishes across the network.
