Kong · Schema

AppAuthStrategyConfigKeyAuth

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.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
key_names	array	The names of the headers containing the API key. You can specify multiple header names.
ttl	object	Default maximum Time-To-Live for keys created under this strategy.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AppAuthStrategyConfigKeyAuth",
  "title": "AppAuthStrategyConfigKeyAuth",
  "description": "The most basic mode to configure an Application Auth Strategy for an API Product Version. \nUsing this mode will allow developers to generate API keys that will authenticate their application requests. \nOnce authenticated, an application will be granted access to any Product Version it is registered for that is configured for Key Auth.\n",
  "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"
          ],
          "x-speakeasy-unknown-values": "allow"
        }
      },
      "required": [
        "value",
        "unit"
      ]
    }
  },
  "additionalProperties": false
}