API7 Docs
API7 GatewayAPI7 Enterprise Developer Portal APIsList all DCR providers

List all DCR providers

GET /api/dcr_providers

GET /api/dcr_providers

Interactive request editor loads with JavaScript.

Authorization

BearerAuth DeveloperIDHeader
AuthorizationBearer <token>

In: header

X-Portal-Developer-ID<token>

In: header

Query Parameters

page?integer

Page number of the listed resources. Used together with page_size. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.

Formatint32
Range1 <= value
page_size?integer

Number of resources listed per page. Used together with page. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.

Formatint32
Range1 <= value
direction?string

Order to list the resources by. The sorting index follows the configuration of order_by.

Default"desc"

Value in

  • "asc"
  • "desc"
order_by?string

Index to order resources by.

Default"updated_at"

Value in

  • "created_at"
  • "updated_at"
search?string

Condition to search resources by.

Response Body

application/json

application/json

application/json

curl -X GET "$API_BASE_URL/api/dcr_providers?search=version%253Dv2"

{
  "list": [
    {
      "id": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101",
      "name": "string",
      "provider_type": "oidc",
      "issuer": "string"
    }
  ],
  "total": 1
}
Complete operation details and schema variants

GET /api/dcr_providers

List all DCR providers

Parameters

  • page (query, integer, optional): Page number of the listed resources. Used together with page_size. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.
  • page_size (query, integer, optional): Number of resources listed per page. Used together with page. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.
  • direction (query, string, optional): Order to list the resources by. The sorting index follows the configuration of order_by.
  • order_by (query, string, optional): Index to order resources by.
  • search (query, string, optional): Condition to search resources by.

Responses

  • 200:
  • list (array, required): An array of DCR providers.
  • list[].id (string, required): The object ID.
  • list[].name (string, required): The name of the Dynamic Client Registration (DCR) Provider.
  • list[].provider_type (string, optional): The type of DCR provider.
  • list[].issuer (string, required): The issuer URL of the Authorization Server.
  • total (integer, required): Total number of objects.
  • 400: Bad request.
  • status (integer, required): The HTTP status code of the error response.
  • message (string, required): The error message.
  • 401: Unauthorized. Response fields (application/json): identical to GET /api/dcr_providers, response 400 above.
  • 500: Internal server error.

cURL

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

System Settings

Previous Page

Approval

Next Page