Delete Portal

Deletes portal specified in path

delete
builder.apibuilder.svc.cluster.local:3000/v1/internal/portals/{portalId}

Query Parameters

forcestring

If true, delete also related publications entities

Allowed values:truefalse

Default:false

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

No Content.

delete/internal/portals/{portalId}
 

DCR Providers

List DCR providers

Returns a list of DCR providers with their id and active status.

get
builder.apibuilder.svc.cluster.local:3000/v1/internal/dcr-providers

Query Parameters

filterobjectrequired

Filter parameters for filtering by ID

Show Child Parameters

Response

application/json

A response containing a list of DCR providers with their status.

Active Response

The list of items with their active status

dataarray[object]required

The item with id and active status

Show Child Parameters
get/internal/dcr-providers
 
application/json

Inserts or updates a DCR provider

Accepts a raw database representation of the DCR Provider in the response body

put
builder.apibuilder.svc.cluster.local:3000/v1/internal/dcr-providers/{dcrProviderId}

Path Parameters

dcrProviderIdstring(uuid)required

DCR provider identifier

Example:ebbac5b0-ac89-45c3-9d2e-c4542c657e79

Body

application/json

UpdateDcrProviderRequest

Updates a DCR provider.

idstring(uuid)required
org_idstring(uuid)required
namestringrequired

The name of the DCR provider. This is used to identify the DCR provider in the Konnect UI.

>= 1 characters<= 256 characters

provider_typestringrequired

The type of DCR provider. Can be one of the following - auth0, azureAd, curity, okta, http, kongIdentity

Allowed values:auth0azureAdcurityoktahttpkongIdentity

issuerstring(url)required

<= 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
required
DcrConfigAuth0InRequestobject

Payload to update an Auth0 DCR provider.

* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)required
updated_atstring(date-time)required

Response

application/json

A response containing a single DCR provider object.

DcrProviderResponse

A response containing a raw database representation of the DCR Provider.

idstring(uuid)required
org_idstring(uuid)required
namestringrequired

The name of the DCR provider. This is used to identify the DCR provider in the Konnect UI.

>= 1 characters<= 256 characters

provider_typestringrequired

The type of DCR provider. Can be one of the following - auth0, azureAd, curity, okta, http, kongIdentity

Allowed values:auth0azureAdcurityoktahttpkongIdentity

issuerstring(url)required

<= 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
required
DcrConfigAuth0InRequestobject

Payload to update an Auth0 DCR provider.

* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)required
updated_atstring(date-time)required
put/internal/dcr-providers/{dcrProviderId}

Body

{ "id": "93f8380e-7798-4566-99e3-2edf2b57d289", "name": "DCR Auth0 1 - Segment A", "provider_type": "auth0", "issuer": "https://my-issuer.auth0.com/api/v2/", "dcr_config": { "initial_client_id": "abc123", "initial_client_audience": "https://my-custom-domain.com/api/v2/", "use_developer_managed_scopes": false }, "org_id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7", "labels": {}, "created_at": "2023-01-01T00:00:00.000Z", "updated_at": "2023-01-01T00:00:00.000Z" }
 
application/json

Deletes a DCR provider

Deletes a DCR provider.

delete
builder.apibuilder.svc.cluster.local:3000/v1/internal/dcr-providers/{dcrProviderId}

Path Parameters

dcrProviderIdstring(uuid)required

DCR provider identifier

Example:ebbac5b0-ac89-45c3-9d2e-c4542c657e79

Response

No Content.

delete/internal/dcr-providers/{dcrProviderId}