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

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

# List Identity Providers

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

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

Retrieves the identity providers available within the portal. This operation provides information about various identity providers for SAML or OIDC authentication integrations.

## Path parameters

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

## Query parameters

- `filter` (object, optional) - Filter identity providers returned in the response.

## Responses

- `200` - A collection of identity providers. This response contains a collection of identity providers, which may include both OIDC and SAML identity providers.
- `401` - Unauthorized
- `403` - Forbidden

## 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:
    parameters:
      - $ref: "#/components/parameters/PortalId"
    get:
      operationId: get-portal-identity-providers
      summary: List Identity Providers
      description: >
        Retrieves the identity providers available within the portal. This
        operation provides information about

        various identity providers for SAML or OIDC authentication integrations.
      parameters:
        - name: filter
          in: query
          description: Filter identity providers returned in the response.
          required: false
          schema:
            type: object
            properties:
              type:
                $ref: "#/components/schemas/StringFieldEqualsFilter"
          style: deepObject
      responses:
        "200":
          $ref: "#/components/responses/IdentityProviders"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
      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.
  schemas:
    StringFieldEqualsFilter:
      description: Filters on the given string field value by exact match.
      properties:
        eq:
          type: string
      title: StringFieldEqualsFilter
      x-examples:
        example-1: equals-some-value
        example-2:
          eq: some-value
    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
    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
    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
    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
  responses:
    IdentityProviders:
      description: >
        A collection of identity providers. This response contains a collection
        of identity providers, which may  include both OIDC and SAML identity
        providers.
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: "#/components/schemas/IdentityProvider"
            title: Identity Provider Collection Response
          examples:
            Identity Provider Collection:
              $ref: "#/components/examples/IdentityProviders"
    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"
  examples:
    IdentityProviders:
      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
        - 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
    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
  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...'`
```
