---
title: "CreateAppAuthStrategyResponse"
url: "https://nov18-dev.movespot.fyi/apis/konnect-application-auth-strategies-2/versions/bd73d053-0812-4727-92b1-ce07bee7e3a8/schemas/CreateAppAuthStrategyResponse"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-application-auth-strategies-2/versions/bd73d053-0812-4727-92b1-ce07bee7e3a8.md

# CreateAppAuthStrategyResponse

## 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
components:
  schemas:
    AppAuthStrategy:
      description: A set of plugin configurations that represent how the gateway will
        perform authentication and authorization for a Product Version. Called
        “Auth Strategy” for short in the context of portals/applications. The
        plugins are synced to any Gateway Service that is currently linked or
        becomes linked to the Product Version.
      type: object
      discriminator:
        propertyName: strategy_type
        mapping:
          key_auth: "#/components/schemas/AppAuthStrategyKeyAuthResponse"
          openid_connect: "#/components/schemas/AppAuthStrategyOpenIDConnectResponse"
      oneOf:
        - $ref: "#/components/schemas/AppAuthStrategyKeyAuthResponse"
        - $ref: "#/components/schemas/AppAuthStrategyOpenIDConnectResponse"
      required:
        - strategy_type
      title: AppAuthStrategy
    AppAuthStrategyKeyAuthResponse:
      description: Response payload from creating or updating a Key Auth Application
        Auth Strategy
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        name:
          $ref: "#/components/schemas/AuthStrategyName"
        display_name:
          $ref: "#/components/schemas/AuthStrategyDisplayName"
        strategy_type:
          type: string
          enum:
            - key_auth
        configs:
          description: JSON-B object containing the configuration for the Key Auth strategy
          type: object
          additionalProperties: false
          properties:
            key-auth:
              $ref: "#/components/schemas/AppAuthStrategyConfigKeyAuth"
          required:
            - key-auth
        active:
          description: At least one published entity is using this auth strategy.
          type: boolean
        dcr_provider:
          type: object
          additionalProperties: false
          nullable: true
          properties:
            id:
              $ref: "#/components/schemas/UUID"
            name:
              type: string
            display_name:
              $ref: "#/components/schemas/DcrProviderDisplayName"
            provider_type:
              description: The type of DCR provider.
              type: string
              enum:
                - auth0
                - azureAd
                - curity
                - okta
                - http
          required:
            - id
            - name
            - provider_type
        labels:
          $ref: "#/components/schemas/Labels"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        supports_multiple_credentials:
          description: |
            Indicates whether this auth strategy supports multiple credentials.
            Always `true` for KEY_AUTH.
          type: boolean
          default: true
          readOnly: true
      additionalProperties: false
      required:
        - id
        - name
        - display_name
        - strategy_type
        - configs
        - active
        - dcr_provider
        - labels
        - created_at
        - updated_at
      title: AppAuthStrategyKeyAuthResponse
    AppAuthStrategyOpenIDConnectResponse:
      description: Response payload from creating an OIDC Application Auth Strategy
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        name:
          $ref: "#/components/schemas/AuthStrategyName"
        display_name:
          $ref: "#/components/schemas/AuthStrategyDisplayName"
        strategy_type:
          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
        active:
          description: At least one published entity is using this auth strategy.
          type: boolean
        dcr_provider:
          type: object
          additionalProperties: false
          nullable: true
          properties:
            id:
              $ref: "#/components/schemas/UUID"
            name:
              type: string
            display_name:
              $ref: "#/components/schemas/DcrProviderDisplayName"
            provider_type:
              description: The type of DCR provider.
              type: string
              enum:
                - auth0
                - azureAd
                - curity
                - okta
                - http
          required:
            - id
            - name
            - provider_type
        labels:
          $ref: "#/components/schemas/Labels"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        supports_multiple_credentials:
          description: >
            Indicates whether this auth strategy supports multiple credentials.

            - `true` for Key Auth strategies and when supported for Client
            Credentials strategies

            - `false` when not supported for Client Credentials strategies
          type: boolean
          readOnly: true
      additionalProperties: false
      required:
        - id
        - name
        - display_name
        - strategy_type
        - configs
        - active
        - dcr_provider
        - labels
        - created_at
        - updated_at
      title: AppAuthStrategyOpenIDConnectResponse
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    AuthStrategyName:
      description: >
        The name of the auth strategy. This is used to identify the auth
        strategy in the Konnect UI.
      type: string
      maxLength: 256
      minLength: 1
    AuthStrategyDisplayName:
      description: >
        The display name of the Auth strategy. This is used to identify the Auth
        strategy in the Portal UI.
      type: string
      maxLength: 256
    AppAuthStrategyConfigKeyAuth:
      description: >
        The most basic mode to configure an Application Auth Strategy for an API
        Product Version. 

        Using this mode will allow developers to generate API keys 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 Key Auth.
      type: object
      properties:
        key_names:
          description: The names of the headers containing the API key. You can specify
            multiple header names.
          type: array
          items:
            type: string
            maxLength: 256
          maxItems: 10
          minItems: 1
        ttl:
          description: Default maximum Time-To-Live for keys created under this strategy.
          type: object
          properties:
            value:
              type: integer
              minimum: 1
            unit:
              type: string
              enum:
                - days
                - weeks
                - years
          required:
            - value
            - unit
      additionalProperties: false
      title: AppAuthStrategyConfigKeyAuth
    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
    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
    CreateAppAuthStrategyResponse:
      $ref: "#/components/schemas/AppAuthStrategy"
```
