Kong · Schema

AuthStrategyKeyAuth

KeyAuth Auth strategy that the application uses.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen-Source

Properties

Name Type Description
id string The Application Auth Strategy ID.
name string
credential_type string
key_names array
ttl object Default maximum Time-To-Live for keys created under this strategy.
View JSON Schema on GitHub

JSON Schema

kong-authstrategykeyauth-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AuthStrategyKeyAuth",
  "title": "AuthStrategyKeyAuth",
  "description": "KeyAuth Auth strategy that the application uses.",
  "type": "object",
  "properties": {
    "id": {
      "description": "The Application Auth Strategy ID.",
      "type": "string",
      "format": "uuid",
      "example": "b9e81174-b5bb-4638-a3c3-8afe61a0abf8",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "example": "name",
      "default": "name"
    },
    "credential_type": {
      "type": "string",
      "enum": [
        "key_auth"
      ]
    },
    "key_names": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "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,
  "required": [
    "id",
    "name",
    "credential_type",
    "key_names"
  ]
}