---
title: "SAML Identity Provider Config"
url: "https://nov18-dev.movespot.fyi/apis/konnect-identity-3/versions/7179cf49-bbc4-42fb-b00f-57a9115554be/schemas/SAMLIdentityProviderConfig"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-identity-3/versions/7179cf49-bbc4-42fb-b00f-57a9115554be.md

# SAML Identity Provider Config

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

## OpenAPI definition

```yaml
openapi: 3.0.2
info:
  title: Konnect Identity
  version: 3.0.2
servers:
  - url: https://global.api.konghq.com/v3
    description: Global Base URL
components:
  schemas:
    SAMLIdentityProviderMetadataURL:
      description: The identity provider's metadata URL where the identity provider's
        metadata can be obtained.
      type: string
      format: uri
      example: https://mocksaml.com/api/saml/metadata
      title: SAML Identity Provider Metadata URL
    SAMLIdentityProviderMetadata:
      description: >
        The identity provider's SAML metadata. If the identity provider supports
        a metadata URL, you can use the `idp_metadata_url` field instead.
      type: string
      example: |
        <?xml version="1.0" encoding="UTF-8"?>
        <EntityDescriptor xmlns="urn:oasis:names:tc:SAML:2.0:metadata">
          <!-- SAML metadata content here -->
        </EntityDescriptor>
      title: SAML Identity Provider Metadata
    SAMLIdentityProviderConfig:
      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: uri
          example: https://cloud.konghq.com/v2/authenticate/the-saml-konnect-org/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 URL where the SAML identity provider sends authentication
            responses after successful login attempts.
          type: string
          format: uri
          example: https://cloud.konghq.com/v2/authenticate/the-saml-konnect-org/saml/acs
          readOnly: true
      additionalProperties: false
      title: SAML Identity Provider Config
```
