Kong · Schema

AppAuthStrategyKeyAuthRequest

Request for creating a Key Auth Application Auth Strategy

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
name object
display_name object
strategy_type string
configs object JSON-B object containing the configuration for the Key Auth strategy
labels object
View JSON Schema on GitHub

JSON Schema

kong-appauthstrategykeyauthrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AppAuthStrategyKeyAuthRequest",
  "title": "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"
  ]
}