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

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

# AppAuthStrategyKeyAuthRequest

Request for creating a Key Auth Application Auth Strategy

## 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:
    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
    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
    AppAuthStrategyKeyAuthRequest:
      description: Request for creating a Key Auth Application Auth Strategy
      type: object
      properties:
        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
        labels:
          $ref: "#/components/schemas/Labels"
      additionalProperties: false
      required:
        - name
        - display_name
        - strategy_type
        - configs
      title: AppAuthStrategyKeyAuthRequest
```
