Kong · Schema

MultiKeyAuth

Defines an authentication strategy based on one or more API keys passed via HTTP headers. This strategy supports integrations that require custom headers for credential-based access, allowing flexibility across providers with different authentication header requirements.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen-Source

Properties

Name Type Description
type string
config object
View JSON Schema on GitHub

JSON Schema

kong-multikeyauth-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MultiKeyAuth",
  "title": "MultiKeyAuth",
  "description": "Defines an authentication strategy based on one or more API keys passed via HTTP headers.\nThis strategy supports integrations that require custom headers for credential-based access,\nallowing flexibility across providers with different authentication header requirements.\n",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "const": "multi_key_auth"
    },
    "config": {
      "type": "object",
      "properties": {
        "headers": {
          "description": "A list of header definitions used to transmit API credentials to the integration's external API.\nEach header represents a unique key required by the provider.\n",
          "type": "array",
          "items": {
            "type": "object",
            "title": "KeyAuthHeader",
            "required": [
              "name",
              "display_name",
              "description"
            ],
            "properties": {
              "name": {
                "description": "The exact name of the HTTP request header where the credential should be inserted.",
                "type": "string",
                "example": "X-API-Key"
              },
              "display_name": {
                "description": "An optional user-friendly label for the key, used in UI forms to guide users.",
                "type": "string",
                "example": "API Key",
                "nullable": true
              },
              "description": {
                "description": "An optional brief explanation of the purpose or usage of the key.",
                "type": "string",
                "nullable": true
              }
            }
          },
          "minItems": 1
        }
      },
      "required": [
        "headers"
      ]
    }
  },
  "required": [
    "type",
    "config"
  ]
}