Kong · Schema

IdP Configuration

The IdP object contains the configuration data for the OIDC authentication integration. NOTE: The `openid` scope is required. Removing it could break the OIDC integration.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
issuer string
login_path string
client_id string
scopes array
claim_mappings object
View JSON Schema on GitHub

JSON Schema

kong-idp-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/IdP",
  "title": "IdP Configuration",
  "description": "The IdP object contains the configuration data for the OIDC authentication integration.\n\nNOTE: The `openid` scope is required. Removing it could break the OIDC integration.",
  "type": "object",
  "properties": {
    "issuer": {
      "type": "string",
      "format": "uri",
      "example": "https://myidp.com/oauth2"
    },
    "login_path": {
      "type": "string",
      "example": "myapp"
    },
    "client_id": {
      "type": "string",
      "example": "YOUR_CLIENT_ID"
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "default": [
        "email",
        "openid",
        "profile"
      ]
    },
    "claim_mappings": {
      "type": "object",
      "minProperties": 3,
      "properties": {
        "name": {
          "type": "string",
          "example": "name",
          "default": "name"
        },
        "email": {
          "type": "string",
          "example": "email",
          "default": "email"
        },
        "groups": {
          "type": "string",
          "example": "custom-groups-claim",
          "default": "groups"
        }
      }
    }
  }
}