DCR Providers

List DCR Providers

Returns a paginated collection of DCR providers.

get/v2/dcr-providers

Query parameters

page[size]integer
Example:10

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

page[number]integer
Example:1

Determines which page of the entities to retrieve.

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

A paginated list response for a collection of DCR providers

Example response

{
  "data": [
    {
      "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
      "labels": {
        "env": "test"
      },
      "created_at": "2022-11-04T20:10:06.927Z",
      "updated_at": "2022-11-04T20:10:06.927Z"
    }
  ],
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  }
}

Changes

Changed in 8 of the 75 revisions of this API.10318

    • the provider_type response property const value auth0 was added for the status 200

      response-property-const-added

    • the provider_type response property const value azureAd was added for the status 200

      response-property-const-added

    • the provider_type response property const value curity was added for the status 200

      response-property-const-added

    • the provider_type response property const value http was added for the status 200

      response-property-const-added

    • the provider_type response property const value kongIdentity was added for the status 200

      response-property-const-added

    • the provider_type response property const value okta was added for the status 200

      response-property-const-added

    • removed the auth0 enum value from the data/items/allOf[subschema #2]/oneOf[subschema #1: DCR provider - Auth0]/provider_type response property for the response status 200

      response-property-enum-value-removed

    • removed the azureAd enum value from the data/items/allOf[subschema #2]/oneOf[subschema #2: DCR provider - Azure AD]/provider_type response property for the response status 200

      response-property-enum-value-removed

    • removed the curity enum value from the data/items/allOf[subschema #2]/oneOf[subschema #3: DCR provider - Curity]/provider_type response property for the response status 200

      response-property-enum-value-removed

    • removed the http enum value from the data/items/allOf[subschema #2]/oneOf[subschema #6: DCR provider - HTTP]/provider_type response property for the response status 200

      response-property-enum-value-removed

    • removed the kongIdentity enum value from the data/items/allOf[subschema #2]/oneOf[subschema #5: DCR provider - Kong Identity]/provider_type response property for the response status 200

      response-property-enum-value-removed

    • removed the okta enum value from the data/items/allOf[subschema #2]/oneOf[subschema #4: DCR provider - OKTA]/provider_type response property for the response status 200

      response-property-enum-value-removed

  • a2e95e9f6c8011See the full diff
    • added DcrProviderKongIdentity to the data/items/allOf[subschema #2]/ response property oneOf list for the response status 200

      response-property-one-of-added

    • added kongIdentity discriminator mapping keys to the data/items/allOf[subschema #2]/ response property for the response status 200

      response-property-discriminator-mapping-added

    This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added auth0 azureAd curity okta http discriminator mapping keys to the data/items/allOf[subschema #2]/ response property for the response status 200

      response-property-discriminator-mapping-added

    • removed the optional property data/items/allOf[subschema #2]/oneOf[subschema #2: DCR provider - Azure AD]/dcr_config/allow_multiple_credentials from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/allOf[subschema #2]/oneOf[subschema #4: DCR provider - OKTA]/dcr_config/allow_multiple_credentials from the response with the 200 status

      response-optional-property-removed

    • added the optional property data/items/allOf[subschema #2]/oneOf[subschema #2: DCR provider - Azure AD]/dcr_config/allow_multiple_credentials to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/allOf[subschema #2]/oneOf[subschema #4: DCR provider - OKTA]/dcr_config/allow_multiple_credentials to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/allOf[subschema #2]/oneOf[subschema #5: DCR provider - HTTP]/dcr_config/allow_multiple_credentials to the response with the 200 status

      response-optional-property-added

    • added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

    • the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterChoiceItem]/source became nullable for the status 400

      response-property-became-nullable

    • the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterDependentItem]/source became nullable for the status 400

      response-property-became-nullable

    • the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMaximumLength]/source became nullable for the status 400

      response-property-became-nullable

    • the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/source became nullable for the status 400

      response-property-became-nullable

    • the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/source became nullable for the status 400

      response-property-became-nullable

    • the response property detail became nullable for the status 401

      response-property-became-nullable

    • the response property instance became nullable for the status 401

      response-property-became-nullable

    • the response property status became nullable for the status 401

      response-property-became-nullable

    • the response property title became nullable for the status 401

      response-property-became-nullable

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added