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

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

# Get Identity Provider

`GET` `/portals/{portalId}/identity-providers/{id}`

Operation ID: `get-portal-identity-provider`

Retrieves the configuration of a single identity provider. This operation returns information about a specific identity provider's settings and authentication integration details.

## Path parameters

- `portalId` (string, uuid, required) - ID of the portal.
- `id` (string, uuid, required) - ID of the identity provider.

## Responses

- `200` - An identity provider configuration. This response represents the configuration of a specific identity provider, which can be either OIDC or SAML.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## 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
paths:
  /portals/{portalId}/identity-providers/{id}:
    parameters:
      - $ref: "#/components/parameters/PortalId"
      - $ref: "#/components/parameters/IdentityProviderId"
    get:
      operationId: get-portal-identity-provider
      summary: Get Identity Provider
      description: >
        Retrieves the configuration of a single identity provider. This
        operation returns information about a

        specific identity provider's settings and authentication integration
        details.
      responses:
        "200":
          $ref: "#/components/responses/IdentityProvider"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Portal Auth Settings
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    PortalId:
      schema:
        type: string
        format: uuid
      name: portalId
      in: path
      required: true
      description: ID of the portal.
    IdentityProviderId:
      schema:
        type: string
        format: uuid
        example: d32d905a-ed33-46a3-a093-d8f536af9a8a
      name: id
      in: path
      required: true
      description: ID of the identity provider.
  responses:
    IdentityProvider:
      description: >
        An identity provider configuration. This response represents the
        configuration of a specific identity provider, which can be either OIDC
        or SAML.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/IdentityProvider"
          examples:
            OIDC Identity Provider:
              $ref: "#/components/examples/OIDCIdentityProvider"
            SAML Identity Provider With Meta Data URL:
              $ref: "#/components/examples/SAMLIdentityProvider"
            SAML Identity Provider With Meta Data:
              $ref: "#/components/examples/SAMLIdentityProviderWithMetadata"
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    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
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    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
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: 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
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  examples:
    OIDCIdentityProvider:
      value:
        id: 66da2d42-469d-48cd-9ff3-0db135dd82d8
        type: oidc
        enabled: false
        config:
          issuer_url: https://konghq.okta.com/oauth2/default
          client_id: 0oaqhb43ckTZ02j1F357
          scopes:
            - openid
            - email
            - profile
          claim_mappings:
            email: email
            name: name
            groups: groups
        created_at: 2022-02-07T17:46:57.52Z
        updated_at: 2022-02-07T17:46:57.52Z
    SAMLIdentityProvider:
      value:
        id: a2c3156d-ebb1-432b-b2f1-edcc5f133c60
        type: saml
        enabled: true
        config:
          idp_metadata_url: https://mocksaml.com/api/saml/metadata
          sp_entity_id: https://cloud.konghq.com/sp/00000000-0000-0000-0000-000000000000
          sp_metadata_url: /api/v2/developer/authenticate/saml/metadata
          callback_url: /api/v2/developer/authenticate/saml/acs
        created_at: 2022-02-07T17:46:57.52Z
        updated_at: 2022-02-07T17:46:57.52Z
    SAMLIdentityProviderWithMetadata:
      value:
        id: a2c3156d-ebb1-432b-b2f1-edcc5f133c60
        type: saml
        enabled: true
        config:
          idp_metadata_xml: |
            <?xml version="1.0" encoding="UTF-8"?>
            <EntityDescriptor xmlns="urn:oasis:names:tc:SAML:2.0:metadata">
            <!-- SAML metadata content here -->
            </EntityDescriptor>
          sp_entity_id: https://cloud.konghq.com/sp/00000000-0000-0000-0000-000000000000
          sp_metadata_url: /api/v2/developer/authenticate/saml/metadata
          callback_url: /api/v2/developer/authenticate/saml/acs
        created_at: 2022-02-07T17:46:57.52Z
        updated_at: 2022-02-07T17:46:57.52Z
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
