---
title: "Identity Provider"
url: "https://nov18-dev.movespot.fyi/apis/portal-management-v3-3/versions/209d0e93-97b5-4dd3-a5a4-172ba6d8a51e/schemas/IdentityProvider"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-management-v3-3/versions/209d0e93-97b5-4dd3-a5a4-172ba6d8a51e.md

# Identity Provider

The identity provider that contains configuration data for authentication integration.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Portal Management V3
  version: 3.4.1
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
components:
  schemas:
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    IdentityProviderType:
      description: Specifies the type of identity provider.
      type: string
      example: oidc
      enum:
        - oidc
        - saml
    IdentityProviderEnabled:
      description: >
        Indicates whether the identity provider is enabled.

        Only one identity provider can be active at a time, such as SAML or
        OIDC.
      type: boolean
      example: true
      default: false
      title: Identity Provider Enabled Property
    OIDCIdentityProviderConfig:
      description: The identity provider that contains configuration data for the OIDC
        authentication integration.
      type: object
      properties:
        issuer_url:
          $ref: "#/components/schemas/OIDCIdentityProviderIssuer"
        client_id:
          $ref: "#/components/schemas/OIDCIdentityProviderClientId"
        client_secret:
          $ref: "#/components/schemas/OIDCIdentityProviderClientSecret"
        scopes:
          $ref: "#/components/schemas/OIDCIdentityProviderScopes"
        claim_mappings:
          $ref: "#/components/schemas/OIDCIdentityProviderClaimMappings"
      additionalProperties: false
      required:
        - issuer_url
        - client_id
      title: OIDC Identity Provider Config
    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: 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
        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
      title: SAML Identity Provider Config
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    OIDCIdentityProviderIssuer:
      description: The issuer URI of the identity provider. This is the URL where the
        provider's metadata can be obtained.
      type: string
      format: uri
      example: https://konghq.okta.com/oauth2/default
      title: OIDC Identity Provider Issuer Property
    OIDCIdentityProviderClientId:
      description: The client ID assigned to your application by the identity provider.
      type: string
      example: YOUR_CLIENT_ID
      title: OIDC Identity Provider Login Client Id Property
    OIDCIdentityProviderClientSecret:
      description: The Client Secret assigned to your application by the identity provider.
      type: string
      example: YOUR_CLIENT_SECRET
      title: OIDC Identity Provider Login Client Secret Property
      writeOnly: true
    OIDCIdentityProviderScopes:
      description: The scopes requested by your application when authenticating with
        the identity provider.
      type: array
      items:
        type: string
      default:
        - email
        - openid
        - profile
      title: OIDC Identity Provider Scopes Property
    OIDCIdentityProviderClaimMappings:
      description: >
        Defines the mappings between OpenID Connect (OIDC) claims and local
        claims used by your application for 

        authentication.
      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
      title: OIDC Claim Mappings
    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
    IdentityProvider:
      description: The identity provider that contains configuration data for
        authentication integration.
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        type:
          $ref: "#/components/schemas/IdentityProviderType"
        enabled:
          $ref: "#/components/schemas/IdentityProviderEnabled"
        config:
          type: object
          oneOf:
            - $ref: "#/components/schemas/OIDCIdentityProviderConfig"
            - $ref: "#/components/schemas/SAMLIdentityProviderConfig"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      title: Identity Provider
```
