Kong · Schema

SAML Identity Provider Config

The identity provider that contains configuration data for the SAML authentication integration.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen-Source

Properties

Name Type Description
idp_metadata_url object
idp_metadata_xml object
sp_metadata_url string
sp_entity_id string The entity ID of the service provider (SP).
login_url string The URL to redirect users to for initiating login with the identity provider.
callback_url string The path URL where the SAML identity provider sends authentication responses after successful login attempts.
View JSON Schema on GitHub

JSON Schema

kong-samlidentityproviderconfig-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SAMLIdentityProviderConfig",
  "title": "SAML Identity Provider Config",
  "description": "The identity provider that contains configuration data for the SAML authentication integration.",
  "type": "object",
  "properties": {
    "idp_metadata_url": {
      "$ref": "#/components/schemas/SAMLIdentityProviderMetadataURL"
    },
    "idp_metadata_xml": {
      "$ref": "#/components/schemas/SAMLIdentityProviderMetadata"
    },
    "sp_metadata_url": {
      "type": "string",
      "format": "path",
      "example": "/api/v2/developer/authenticate/saml/metadata",
      "readOnly": true
    },
    "sp_entity_id": {
      "description": "The entity ID of the service provider (SP).",
      "type": "string",
      "example": "https://cloud.konghq.com/sp/00000000-0000-0000-0000-000000000000",
      "readOnly": true
    },
    "login_url": {
      "description": "The URL to redirect users to for initiating login with the identity provider.",
      "type": "string",
      "example": "https://cloud.konghq.com/login/the-saml-konnect-org",
      "readOnly": true
    },
    "callback_url": {
      "description": "The path URL where the SAML identity provider sends authentication responses after successful login attempts.",
      "type": "string",
      "format": "path",
      "example": "/api/v2/developer/authenticate/saml/acs",
      "readOnly": true
    }
  },
  "additionalProperties": false
}