Create an DCR provider

POST /api/dcr_providers

Interactive request editor loads with JavaScript.

Authorization

X-API-KEY<token>

In: header

Request Body

application/json

name*string

The name of the Dynamic Client Registration (DCR) Provider.

Length1 <= length

provider_type?string

The type of DCR provider. Use "oidc" for standard OIDC Dynamic Client Registration (RFC 7591/7592), or "http_bridge" for a customer-implemented HTTP Bridge service.

Default"oidc"

Value in

"oidc"
"http_bridge"

issuer*string

The issuer URL of the Authorization Server. Required for all provider types — used by the data plane (APISIX) for token validation.

Formaturi

provider_config?

Provider-specific configuration. Required when provider_type is "http_bridge".

headers?

Custom headers to include in requests to the Authorization Server or HTTP Bridge.

desc?string

The object description.

Lengthlength <= 65536

labels?

Key-value pairs of labels.

Response Body

`application/json`

curl -X POST "$API_BASE_URL/api/dcr_providers" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "issuer": "http://example.com"  }'

Successfully retrieved or modified the DCR provider.

{
  "value": {
    "name": "string",
    "provider_type": "oidc",
    "issuer": "http://example.com",
    "provider_config": {
      "base_url": "http://example.com"
    },
    "headers": {
      "Authorization": "Bearer $TOKEN"
    },
    "desc": "Object description.",
    "labels": {
      "version": "v2",
      "env": "prod"
    },
    "id": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101",
    "created_at": 1742288232,
    "updated_at": 1742288235
  }
}

Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.

{
  "value": {},
  "error_msg": "error message"
}

Complete operation details and schema variants

POST /api/dcr_providers

Create an DCR provider

IAM Action: portal:CreateDCRProvider, Resource: arn:api7:portal:dcrprovider/*

Parameters

Request body

Content type: application/json

name (string, required): The name of the Dynamic Client Registration (DCR) Provider.
provider_type (string, optional): The type of DCR provider. Use "oidc" for standard OIDC Dynamic Client Registration (RFC 7591/7592), or "http_bridge" for a customer-implemented HTTP Bridge service.
issuer (string, required): The issuer URL of the Authorization Server. Required for all provider types — used by the data plane (APISIX) for token validation.
provider_config (object, optional): Provider-specific configuration. Required when provider_type is "http_bridge".
provider_config.base_url (string, optional): The base URL of the HTTP Bridge service.
headers (object, optional): Custom headers to include in requests to the Authorization Server or HTTP Bridge.
desc (string, optional): The object description.
labels (object, optional): Key-value pairs of labels.

Responses

200: Successfully retrieved or modified the DCR provider.
allOf variant 1
value (object, optional): The specific resource.
allOf variant 2
value (object, optional):
allOf variant 1
value.name (string, required): The name of the Dynamic Client Registration (DCR) Provider.
value.provider_type (string, optional): The type of DCR provider. Use "oidc" for standard OIDC Dynamic Client Registration (RFC 7591/7592), or "http_bridge" for a customer-implemented HTTP Bridge service.
value.issuer (string, required): The issuer URL of the Authorization Server. Required for all provider types — used by the data plane (APISIX) for token validation.
value.provider_config (object, optional): Provider-specific configuration. Required when provider_type is "http_bridge".
value.provider_config.base_url (string, optional): The base URL of the HTTP Bridge service.
value.headers (object, optional): Custom headers to include in requests to the Authorization Server or HTTP Bridge.
value.desc (string, optional): The object description.
value.labels (object, optional): Key-value pairs of labels.
allOf variant 2
value.id (string, optional): The object ID.
value.created_at (integer, optional): The object created timestamp.
value.updated_at (integer, optional): The object updated timestamp.
400: Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.
value (object, optional): The specific resource.
error_msg (string, optional): The error message.

cURL

curl -X POST '$API_BASE_URL/api/dcr_providers'

Create an DCR provider

200application/json

400application/json

`application/json`

`application/json`