---
title: "AppAuthStrategyOpenIDConnectResponse"
url: "https://nov18-dev.movespot.fyi/apis/internal-api-builder-v1-1/versions/37dd8750-3a87-4f5b-aa5c-d7d8aa14eea8/schemas/AppAuthStrategyOpenIDConnect"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/internal-api-builder-v1-1/versions/37dd8750-3a87-4f5b-aa5c-d7d8aa14eea8.md

# AppAuthStrategyOpenIDConnectResponse

Response payload from creating an OIDC Application Auth Strategy

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Internal API-Builder v1
  version: 1.0.13
servers:
  - url: builder.apibuilder.svc.cluster.local:3000/v1
    description: Konnect cluster
components:
  schemas:
    AppAuthStrategyConfigOpenIDConnect:
      description: >
        A more advanced mode to configure an API Product Version’s Application
        Auth Strategy. 

        Using this mode will allow developers to use API credentials issued from
        an external IdP that will authenticate their application requests. 

        Once authenticated, an application will be granted access to any Product
        Version it is registered for that is configured for the same Auth
        Strategy. 

        An OIDC strategy may be used in conjunction with a DCR provider to
        automatically create the IdP application.
      type: object
      properties:
        issuer:
          type: string
          format: url
          maxLength: 256
        credential_claim:
          type: array
          items:
            type: string
            maxLength: 128
          maxItems: 10
        scopes:
          type: array
          items:
            type: string
            maxLength: 128
          maxItems: 50
        auth_methods:
          type: array
          items:
            type: string
            maxLength: 64
          maxItems: 10
      additionalProperties: true
      required:
        - issuer
        - credential_claim
        - scopes
        - auth_methods
      title: AppAuthStrategyConfigOpenIDConnect
    DcrProvider:
      type: object
      properties:
        id:
          type: string
          format: uuid
        org_id:
          type: string
          format: uuid
        name:
          $ref: "#/components/schemas/DcrProviderName"
        provider_type:
          description: The type of DCR provider. Can be one of the following - auth0,
            azureAd, curity, okta, http, kongIdentity
          type: string
          enum:
            - auth0
            - azureAd
            - curity
            - okta
            - http
            - kongIdentity
        issuer:
          type: string
          format: url
          maxLength: 256
        labels:
          $ref: "#/components/schemas/LabelsUpdate"
        dcr_config:
          anyOf:
            - $ref: "#/components/schemas/UpdateDcrConfigAuth0InRequest"
            - $ref: "#/components/schemas/UpdateDcrConfigAzureAdInRequest"
            - $ref: "#/components/schemas/UpdateDcrConfigCurityInRequest"
            - $ref: "#/components/schemas/UpdateDcrConfigOktaInRequest"
            - $ref: "#/components/schemas/UpdateDcrConfigHttpInRequest"
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - name
        - provider_type
        - issuer
        - dcr_config
        - org_id
        - created_at
        - updated_at
      title: DcrProvider
    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
    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
    LabelsUpdate:
      description: >
        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 "_".
      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
        nullable: true
      maxProperties: 50
      nullable: true
      writeOnly: true
    UpdateDcrConfigAuth0InRequest:
      description: Payload to update an Auth0 DCR provider.
      type: object
      properties:
        initial_client_id:
          $ref: "#/components/schemas/DcrConfigPropertyInitialClientId"
        initial_client_secret:
          $ref: "#/components/schemas/DcrConfigPropertyInitialClientSecret"
        initial_client_audience:
          $ref: "#/components/schemas/DcrConfigPropertyInitialClientAudience"
        use_developer_managed_scopes:
          type: boolean
      additionalProperties: false
      title: DcrConfigAuth0InRequest
    UpdateDcrConfigAzureAdInRequest:
      description: Payload to update an Azure AD DCR provider.
      type: object
      properties:
        initial_client_id:
          $ref: "#/components/schemas/DcrConfigPropertyInitialClientId"
        initial_client_secret:
          $ref: "#/components/schemas/DcrConfigPropertyInitialClientSecret"
      additionalProperties: false
      title: DcrConfigAzureAdInRequest
    UpdateDcrConfigCurityInRequest:
      description: Payload to update a Curity DCR provider.
      type: object
      properties:
        initial_client_id:
          $ref: "#/components/schemas/DcrConfigPropertyInitialClientId"
        initial_client_secret:
          $ref: "#/components/schemas/DcrConfigPropertyInitialClientSecret"
      additionalProperties: false
      title: DcrConfigCurityInRequest
    UpdateDcrConfigOktaInRequest:
      description: Payload to update an Okta DCR provider.
      type: object
      properties:
        dcr_token:
          $ref: "#/components/schemas/DcrConfigPropertyDcrToken"
      additionalProperties: false
      title: DcrConfigOktaInRequest
    UpdateDcrConfigHttpInRequest:
      description: Payload to update an HTTP DCR provider.
      type: object
      properties:
        dcr_base_url:
          $ref: "#/components/schemas/DcrBaseUrl"
        api_key:
          $ref: "#/components/schemas/DcrConfigPropertyApiKey"
        disable_event_hooks:
          $ref: "#/components/schemas/DcrConfigPropertyDisableEventHooks"
        disable_refresh_secret:
          $ref: "#/components/schemas/DcrConfigPropertyDisableRefreshSecret"
        allow_multiple_credentials:
          $ref: "#/components/schemas/DcrConfigPropertyAllowMultipleCredentials"
      additionalProperties: false
      title: CreateDcrConfigHttpInRequest
    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
    DcrConfigPropertyInitialClientSecret:
      description: >
        This secret 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
      title: DcrConfigPropertyInitialClientSecret
    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
    DcrConfigPropertyDcrToken:
      description: >
        This secret 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
      title: DcrConfigPropertyInitialDcrToken
    DcrBaseUrl:
      description: >
        The base URL of the DCR server. This is the URL that will be used to
        make the HTTP requests from Konnect to the DCR provider.

        This URL must be accessible from the Konnect service.
      type: string
      format: url
      maxLength: 256
    DcrConfigPropertyApiKey:
      description: >
        This is the API Key that will be sent with each HTTP request to the
        custom DCR server. It can be

        verified on the server to ensure that incoming requests are coming from
        Konnect.
      type: string
      title: DcrConfigPropertyApiKey
    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
    AppAuthStrategyOpenIDConnect:
      description: Response payload from creating an OIDC Application Auth Strategy
      type: object
      properties:
        id:
          type: string
          format: uuid
        org_id:
          type: string
          format: uuid
        name:
          description: |
            The name of the app auth strategy.
          type: string
          maxLength: 256
          minLength: 1
        display_name:
          description: >
            The display name of the Auth strategy. This is used to identify the
            Auth strategy in the Portal UI.
          type: string
          maxLength: 256
        strategy_type:
          description: The stategy type. Can be either openid_connect or key_auth.
          type: string
          enum:
            - openid_connect
        configs:
          description: JSON-B object containing the configuration for the OIDC strategy
          type: object
          additionalProperties: false
          properties:
            openid-connect:
              $ref: "#/components/schemas/AppAuthStrategyConfigOpenIDConnect"
          required:
            - openid-connect
        dcr_provider:
          $ref: "#/components/schemas/DcrProvider"
        labels:
          $ref: "#/components/schemas/Labels"
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      additionalProperties: false
      required:
        - id
        - name
        - display_name
        - strategy_type
        - org_id
        - configs
        - labels
        - created_at
        - updated_at
      title: AppAuthStrategyOpenIDConnectResponse
```
