Kong · Schema

CreateMultiKeyAuthCredential

Payload used to create an `Multi Key` credential for an integration instance.

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-createmultikeyauthcredential-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateMultiKeyAuthCredential",
  "title": "CreateMultiKeyAuthCredential",
  "description": "Payload used to create an `Multi Key` credential for an integration instance.",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "const": "multi_key_auth"
    },
    "config": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "headers": {
          "description": "A list of header key/value pairs used to transmit API credentials to the integration's external API.\nHeader names are defined by the integration within its `Multi Key` authorization strategy definition.\n",
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "name",
              "key"
            ],
            "properties": {
              "name": {
                "description": "Name of the request header",
                "type": "string"
              },
              "key": {
                "description": "The key used to populate the request header",
                "type": "string"
              }
            }
          },
          "example": [
            {
              "name": "x-api-key",
              "key": "9f2a3b4c8d6e7f00112233445566778899aabbccddeeff001122334455667788"
            }
          ]
        }
      },
      "required": [
        "headers"
      ],
      "title": "CreateMultiKeyAuthCredentialConfig",
      "x-speakeasy-param-force-new": true,
      "x-speakeasy-param-suppress-computed-diff": true
    }
  },
  "additionalProperties": false,
  "required": [
    "type",
    "config"
  ],
  "writeOnly": true,
  "x-speakeasy-name-override": "multi_key_auth"
}