2.0.6OAS 3.0

The API for Kong Konnect Portal Application Configuration

API Base URL
  • Server 1:https://us.api.konghq.com/v2

    United-States Production region

  • Server 2:https://eu.api.konghq.com/v2

    Europe Production region

  • Server 3:https://au.api.konghq.com/v2

    Australia Production region

  • Server 4:https://me.api.konghq.com/v2

    Middle-East Production region

  • Server 5:https://in.api.konghq.com/v2

    India Production region

  • Server 6:https://sg.api.konghq.com/v2

    Singapore Production region

Additional Information
Contact Kong

DCR Providers

Dynamic Client Registration Providers are configurations representing an external Identity Provider whose clients (i.e. Applications) Konnect will be authorized to manage.
For instance, they will be able to perform dynamic client registration (DCR) with the provider.
The DCR provider provides credentials to each DCR-enabled application in Konnect that can be used to access Product Versions that the app is registered for.

Create DCR provider

Creates a DCR provider.

post

Body

application/json

CreateDcrProviderRequest

CreateDcrProviderRequestobject

Request body for creating a DCR provider. The provider_type cannot be updated after creation.

One Of
provider_typestringrequired

Allowed values:auth0

dcr_configobjectrequired

Payload to create an Auth0 DCR provider.

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

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.

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 DCR provider object.

CreateDcrProviderResponse

CreateDcrProviderResponse
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

post/dcr-providers

Body

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

List DCR Providers

Returns a paginated collection of DCR providers.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

sortstring

Sorts a collection of DCR Providers. Supported sort attributes are:

  • created_at
  • updated_at
  • provider_type
  • issuer
  • name
filter[id][eq]string

filters DCR Providers by their id

filter[id]string

filters DCR Providers by their id (alias for filter[id][eq])

filter[id][contains]string

filters DCR Providers by their id with a supplied substring

filter[issuer][eq]string

filters DCR Providers by their issuer

filter[issuer]string

filters DCR Providers by their issuer (alias for filter[issuer][eq])

filter[issuer][contains]string

filters DCR Providers by their issuer with a supplied substring

filter[name][eq]string

filters DCR Providers by their name

filter[name]string

filters DCR Providers by their name (alias for filter[name][eq])

filter[name][contains]string

filters DCR Providers by their name with a supplied substring

filter[provider_type][eq]string

filters DCR Providers by their provider type

filter[provider_type]string

filters DCR Providers by their provider type (alias for filter[provider_type][eq])

filter[initial_client_id][eq]string

filters DCR Providers by their initial client id

filter[initial_client_id]string

filters DCR Providers by their initial client id (alias for filter[initial_client_id][eq])

filter[initial_client_id][contains]string

filters DCR Providers by their initial client id with a supplied substring

filter[initial_client_audience][eq]string

filters DCR Providers by their initial client audience

filter[initial_client_audience]string

filters DCR Providers by their initial client audience (alias for filter[initial_client_audience][eq])

filter[initial_client_audience][contains]string

filters DCR Providers by their initial client audience with a supplied substring

Response

application/json

A paginated list response for a collection of DCR providers

ListDcrProvidersResponse

A paginated list response for a collection of DCR providers

* Additional properties are NOT allowed.
dataOne Of
array[object]required
DCR provider - Auth0object

A DCR provider for Auth0 – only properties not included in DcrProviderBase

* Additional properties are NOT allowed.
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
get/dcr-providers
 
application/json

Get a DCR provider

Returns a DCR provider.

get

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

get/dcr-providers/{dcrProviderId}
 
application/json