Kong · Schema

AppAuthStrategyKeyAuthResponse

Response payload from creating or updating a Key Auth Application Auth Strategy

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
id	object
name	object
display_name	object
strategy_type	string
configs	object	JSON-B object containing the configuration for the Key Auth strategy
active	boolean	At least one published entity is using this auth strategy.
dcr_provider	object
labels	object
created_at	object
updated_at	object
supports_multiple_credentials	boolean	Indicates whether this auth strategy supports multiple credentials. Always `true` for KEY_AUTH.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AppAuthStrategyKeyAuthResponse",
  "title": "AppAuthStrategyKeyAuthResponse",
  "description": "Response payload from creating or updating a Key Auth Application Auth Strategy",
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UUID"
    },
    "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"
      ]
    },
    "active": {
      "description": "At least one published entity is using this auth strategy.",
      "type": "boolean"
    },
    "dcr_provider": {
      "type": "object",
      "additionalProperties": false,
      "nullable": true,
      "properties": {
        "id": {
          "$ref": "#/components/schemas/UUID"
        },
        "name": {
          "type": "string"
        },
        "display_name": {
          "$ref": "#/components/schemas/DcrProviderDisplayName"
        },
        "provider_type": {
          "description": "The type of DCR provider.",
          "type": "string",
          "enum": [
            "auth0",
            "azureAd",
            "curity",
            "okta",
            "http"
          ],
          "x-speakeasy-unknown-values": "allow"
        }
      },
      "required": [
        "id",
        "name",
        "provider_type"
      ]
    },
    "labels": {
      "$ref": "#/components/schemas/Labels"
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    },
    "updated_at": {
      "$ref": "#/components/schemas/UpdatedAt"
    },
    "supports_multiple_credentials": {
      "description": "Indicates whether this auth strategy supports multiple credentials.\nAlways `true` for KEY_AUTH.\n",
      "type": "boolean",
      "default": true,
      "readOnly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "name",
    "display_name",
    "strategy_type",
    "configs",
    "active",
    "dcr_provider",
    "labels",
    "created_at",
    "updated_at"
  ]
}