Kong · Schema

PartialAppAuthStrategyConfigKeyAuth

Key Auth configuration for updating an Application Auth Strategy. The ttl field can be set to null to unset the Time-To-Live.

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. Set to null to unset.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PartialAppAuthStrategyConfigKeyAuth",
  "title": "PartialAppAuthStrategyConfigKeyAuth",
  "description": "Key Auth configuration for updating an Application Auth Strategy.\nThe ttl field can be set to null to unset the Time-To-Live.\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. Set to null to unset.",
      "type": "object",
      "nullable": true,
      "properties": {
        "value": {
          "type": "integer",
          "minimum": 1
        },
        "unit": {
          "type": "string",
          "enum": [
            "days",
            "weeks",
            "years"
          ],
          "x-speakeasy-unknown-values": "allow"
        }
      },
      "required": [
        "value",
        "unit"
      ]
    }
  },
  "additionalProperties": false
}