Kong · Schema

OIDC Claim Mappings

Defines the mappings between OpenID Connect (OIDC) claims and local claims used by your application for authentication.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
name string The claim mapping for the user's name.
email string The claim mapping for the user's email address.
groups string The claim mapping for the user's group membership information.
View JSON Schema on GitHub

JSON Schema

kong-oidcidentityproviderclaimmappings-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OIDCIdentityProviderClaimMappings",
  "title": "OIDC Claim Mappings",
  "description": "Defines the mappings between OpenID Connect (OIDC) claims and local claims used by your application for \nauthentication.\n",
  "type": "object",
  "properties": {
    "name": {
      "description": "The claim mapping for the user's name.",
      "type": "string",
      "example": "name",
      "default": "name"
    },
    "email": {
      "description": "The claim mapping for the user's email address.",
      "type": "string",
      "example": "email",
      "default": "email"
    },
    "groups": {
      "description": "The claim mapping for the user's group membership information.",
      "type": "string",
      "example": "groups",
      "default": "groups"
    }
  }
}