Kong · Schema

AppAuthStrategyConfigOpenIDConnect

A more advanced mode to configure an API Product Version’s Application Auth Strategy. Using this mode will allow developers to use API credentials issued from an external IdP that will authenticate their application requests. Once authenticated, an application will be granted access to any Product Version it is registered for that is configured for the same Auth Strategy. An OIDC strategy may be used in conjunction with a DCR provider to automatically create the IdP application.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
issuer string
credential_claim array
scopes array
auth_methods array
View JSON Schema on GitHub

JSON Schema

kong-appauthstrategyconfigopenidconnect-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AppAuthStrategyConfigOpenIDConnect",
  "title": "AppAuthStrategyConfigOpenIDConnect",
  "description": "A more advanced mode to configure an API Product Version\u2019s Application Auth Strategy. \nUsing this mode will allow developers to use API credentials issued from an external IdP that will authenticate their application requests. \nOnce authenticated, an application will be granted access to any Product Version it is registered for that is configured for the same Auth Strategy. \nAn OIDC strategy may be used in conjunction with a DCR provider to automatically create the IdP application.\n",
  "type": "object",
  "properties": {
    "issuer": {
      "type": "string",
      "format": "url",
      "maxLength": 256
    },
    "credential_claim": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 128
      },
      "maxItems": 10
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 128
      },
      "maxItems": 50
    },
    "auth_methods": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 64
      },
      "maxItems": 10
    }
  },
  "additionalProperties": true,
  "required": [
    "issuer",
    "credential_claim",
    "scopes",
    "auth_methods"
  ]
}