---
title: "Get a DCR provider"
url: "https://nov18-dev.movespot.fyi/apis/konnect-application-auth-strategies-internal-2/versions/9b16fcd6-acef-475e-a535-213db82fe10d/operations/get-dcr-provider"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-application-auth-strategies-internal-2/versions/9b16fcd6-acef-475e-a535-213db82fe10d.md

# Get a DCR provider

`GET` `/dcr-providers/{dcrProviderId}`

Operation ID: `get-dcr-provider`

Returns a DCR provider.

## Path parameters

- `dcrProviderId` (string, uuid, required) - DCR provider identifier

## Responses

- `200` - A response containing a single DCR provider object. Sensitive fields will be removed from the response.
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Application Auth Strategies
  version: 2.0.6
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v2
    description: India Production region
  - url: https://sg.api.konghq.com/v2
    description: Singapore Production region
paths:
  /dcr-providers/{dcrProviderId}:
    parameters:
      - $ref: "#/components/parameters/DcrProviderId"
    get:
      operationId: get-dcr-provider
      summary: Get a DCR provider
      description: Returns a DCR provider.
      responses:
        "200":
          $ref: "#/components/responses/GetDcrProvider"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - DCR Providers
components:
  parameters:
    DcrProviderId:
      name: dcrProviderId
      description: DCR provider identifier
      in: path
      required: true
      schema:
        $ref: "#/components/schemas/UUID"
  responses:
    GetDcrProvider:
      description: A response containing a single DCR provider object. Sensitive
        fields will be removed from the response.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/DcrProviderResponse"
          examples:
            DcrProviderAuth0:
              $ref: "#/components/examples/DcrProviderAuth0Response"
            DcrProviderAzureAd:
              $ref: "#/components/examples/DcrProviderAzureAdResponse"
            DcrProviderCurity:
              $ref: "#/components/examples/DcrProviderCurityResponse"
            DcrProviderHttp:
              $ref: "#/components/examples/DcrProviderHttpResponse"
            DcrProviderOkta:
              $ref: "#/components/examples/DcrProviderOktaResponse"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    DcrProviderResponse:
      description: A response containing a single DCR provider object. Sensitive
        fields will be removed from the response.
      type: object
      allOf:
        - $ref: "#/components/schemas/DcrProviderBase"
        - discriminator:
            propertyName: provider_type
          type: object
          oneOf:
            - $ref: "#/components/schemas/DcrProviderAuth0"
            - $ref: "#/components/schemas/DcrProviderAzureAd"
            - $ref: "#/components/schemas/DcrProviderCurity"
            - $ref: "#/components/schemas/DcrProviderOkta"
            - $ref: "#/components/schemas/DcrProviderKongIdentity"
            - $ref: "#/components/schemas/DcrProviderHttp"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    DcrProviderBase:
      description: Properties common to all DCR Providers.
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        name:
          $ref: "#/components/schemas/DcrProviderName"
        display_name:
          $ref: "#/components/schemas/DcrProviderDisplayName"
        provider_type:
          description: The type of DCR provider. Can be one of the following - auth0,
            azureAd, curity, okta, http
          type: string
        issuer:
          description: The issuer of the DCR provider.
          type: string
          format: url
          maxLength: 256
        active:
          description: At least one active auth strategy is using this DCR provider.
          type: boolean
          readOnly: true
        dcr_config:
          description: The DCR configuration for this DCR provider.
          type: object
        labels:
          $ref: "#/components/schemas/Labels"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      additionalProperties: false
      required:
        - id
        - name
        - provider_type
        - issuer
        - active
        - dcr_config
        - created_at
        - updated_at
    DcrProviderAuth0:
      description: A DCR provider for Auth0 -- only properties not included in
        DcrProviderBase
      type: object
      properties:
        provider_type:
          type: string
          enum:
            - auth0
        dcr_config:
          $ref: "#/components/schemas/DcrConfigAuth0InResponse"
      required:
        - provider_type
        - dcr_config
      title: DCR provider - Auth0
    DcrProviderAzureAd:
      description: A DCR provider for Azure AD -- only properties not included in
        DcrProviderBase
      type: object
      properties:
        provider_type:
          type: string
          enum:
            - azureAd
        dcr_config:
          $ref: "#/components/schemas/DcrConfigAzureAdInResponse"
      required:
        - provider_type
        - dcr_config
      title: DCR provider - Azure AD
    DcrProviderCurity:
      description: A DCR provider for Curity -- only properties not included in
        DcrProviderBase
      type: object
      properties:
        provider_type:
          type: string
          enum:
            - curity
        dcr_config:
          $ref: "#/components/schemas/DcrConfigCurityInResponse"
      required:
        - provider_type
        - dcr_config
      title: DCR provider - Curity
    DcrProviderOkta:
      description: A DCR provider for Okta -- only properties not included in
        DcrProviderBase
      type: object
      properties:
        provider_type:
          type: string
          enum:
            - okta
        dcr_config:
          $ref: "#/components/schemas/DcrConfigOktaInResponse"
      required:
        - provider_type
        - dcr_config
      title: DCR provider - OKTA
    DcrProviderKongIdentity:
      description: A DCR provider for Kong Identity -- only properties not included in
        DcrProviderBase
      type: object
      properties:
        provider_type:
          type: string
          enum:
            - kongIdentity
        dcr_config:
          $ref: "#/components/schemas/DcrConfigKongIdentityInResponse"
      required:
        - provider_type
        - dcr_config
      title: DCR provider - Kong Identity
    DcrProviderHttp:
      description: A DCR provider for HTTP -- only properties not included in
        DcrProviderBase
      type: object
      properties:
        provider_type:
          type: string
          enum:
            - http
        dcr_config:
          $ref: "#/components/schemas/DcrConfigHttpInResponse"
      required:
        - provider_type
        - dcr_config
      title: DCR provider - HTTP
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    DcrProviderName:
      description: >
        The name of the DCR provider. This is used to identify the DCR provider
        in the Konnect UI.
      type: string
      maxLength: 256
      minLength: 1
    DcrProviderDisplayName:
      description: >
        The display name of the DCR provider. This is used to identify the DCR
        provider in the Portal UI.
      type: string
      maxLength: 256
      minLength: 1
    Labels:
      description: >
        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 "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: Labels
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    DcrConfigAuth0InResponse:
      description: A DCR provider configuration for Auth0
      type: object
      properties:
        initial_client_id:
          $ref: "#/components/schemas/DcrConfigPropertyInitialClientId"
        initial_client_audience:
          $ref: "#/components/schemas/DcrConfigPropertyInitialClientAudience"
        use_developer_managed_scopes:
          type: boolean
      additionalProperties: false
      required:
        - initial_client_id
        - initial_client_audience
        - use_developer_managed_scopes
      title: DcrConfigAuth0InResponse
    DcrConfigAzureAdInResponse:
      description: A DCR provider configuration for Azure AD
      type: object
      properties:
        initial_client_id:
          $ref: "#/components/schemas/DcrConfigPropertyInitialClientId"
      additionalProperties: false
      required:
        - initial_client_id
      title: DcrConfigAzureAdInResponse
    DcrConfigCurityInResponse:
      description: A DCR provider configuration for Curity
      type: object
      properties:
        initial_client_id:
          $ref: "#/components/schemas/DcrConfigPropertyInitialClientId"
      additionalProperties: false
      required:
        - initial_client_id
      title: DcrConfigCurityInResponse
    DcrConfigOktaInResponse:
      description: A DCR provider configuration for Okta
      type: object
      properties: {}
      additionalProperties: false
      title: DcrConfigOktaInResponse
    DcrConfigKongIdentityInResponse:
      description: A DCR provider configuration for Kong Identity
      type: object
      properties: {}
      additionalProperties: false
      title: DcrConfigKongIdentityInResponse
    DcrConfigHttpInResponse:
      description: A DCR provider configuration for HTTP
      type: object
      properties:
        dcr_base_url:
          type: string
          format: url
        disable_event_hooks:
          $ref: "#/components/schemas/DcrConfigPropertyDisableEventHooks"
        disable_refresh_secret:
          $ref: "#/components/schemas/DcrConfigPropertyDisableRefreshSecret"
        allow_multiple_credentials:
          $ref: "#/components/schemas/DcrConfigPropertyAllowMultipleCredentials"
      additionalProperties: false
      required:
        - dcr_base_url
      title: DcrConfigHttpInResponse
    DcrConfigPropertyInitialClientId:
      description: >
        This ID should be copied from your identity provider's settings after
        you create a client

        and assign it as the management client for DCR for this developer portal
      type: string
      maxLength: 256
      title: DcrConfigPropertyInitialClientId
    DcrConfigPropertyInitialClientAudience:
      description: >
        This is the audience value used for the initial client.

        If using a custom domain on Auth0, this must be set as to the Auth0
        Management API audience value.

        If left blank, the issuer will be used instead.
      type: string
      maxLength: 256
      nullable: true
      title: DcrConfigPropertyInitialClientAudience
    DcrConfigPropertyDisableEventHooks:
      description: This flag disables all the event-hooks on the application flow for
        the DCR provider.
      type: boolean
      title: DcrConfigPropertyDisableEventHooks
    DcrConfigPropertyDisableRefreshSecret:
      description: This flag disable the refresh-secret endpoint on the application
        flow for the DCR provider.
      type: boolean
      title: DcrConfigPropertyDisableRefreshSecret
    DcrConfigPropertyAllowMultipleCredentials:
      description: When enabled, indicates that the DCR provider supports creating and
        managing multiple credentials per application.
      type: boolean
      default: false
      title: DcrConfigPropertyAllowMultipleCredentials
  examples:
    DcrProviderAuth0Response:
      summary: DCR provider Response for Auth0
      value:
        id: 93f8380e-7798-4566-99e3-2edf2b57d289
        name: DCR Auth0 1 - Segment A
        display_name: Auth0 DCR provider
        provider_type: auth0
        issuer: https://my-issuer.auth0.com/api/v2/
        active: true
        dcr_config:
          initial_client_id: abc123
          initial_client_audience: https://my-custom-domain.com/api/v2/
          use_developer_managed_scopes: false
        created_at: 2023-01-01T00:00:00.000Z
        updated_at: 2023-01-01T00:00:00.000Z
    DcrProviderAzureAdResponse:
      summary: DCR provider Response for AzureAd
      value:
        id: 93f8380e-7798-4566-99e3-2edf2b57d289
        name: DCR AzureAd 1 - Segment A
        display_name: Client Credentials
        provider_type: azureAd
        issuer: https://sts.windows.net/my-tenant
        active: true
        dcr_config:
          initial_client_id: abc123
        created_at: 2023-01-01T00:00:00.000Z
        updated_at: 2023-01-01T00:00:00.000Z
    DcrProviderCurityResponse:
      summary: DCR provider Response for Curity
      value:
        id: 93f8380e-7798-4566-99e3-2edf2b57d289
        name: DCR Curity 1 - Segment A
        display_name: Client Credentials
        provider_type: curity
        issuer: https://my-curity-instance.com/oauth/v2/oauth-anonymous/.well-known/openid-configuration
        active: true
        dcr_config:
          initial_client_id: abc123
        created_at: 2023-01-01T00:00:00.000Z
        updated_at: 2023-01-01T00:00:00.000Z
    DcrProviderHttpResponse:
      summary: DCR provider Response for HTTP
      value:
        id: 93f8380e-7798-4566-99e3-2edf2b57d289
        name: DCR HTTP 1 - Segment A
        display_name: Client Credentials
        provider_type: http
        issuer: https://my-issuer-server.com
        active: true
        dcr_config:
          dcr_base_url: https://my-http-dcr-server.com/v1/dcr
        created_at: 2023-01-01T00:00:00.000Z
        updated_at: 2023-01-01T00:00:00.000Z
    DcrProviderOktaResponse:
      summary: DCR provider Response for Okta
      value:
        id: 93f8380e-7798-4566-99e3-2edf2b57d289
        name: DCR Okta 1 - Segment A
        provider_type: okta
        issuer: https://my-issuer.okta.com/default
        active: true
        dcr_config: {}
        created_at: 2023-01-01T00:00:00.000Z
        updated_at: 2023-01-01T00:00:00.000Z
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
```
