Portal Auth Settings

List Identity Providers

Changed on

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

get/v3/portals/{portalId}/identity-providers

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/portals/{portalId}/identity-providers
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Query parameters

Filter identity providers returned in the response.

Response

A collection of identity providers. This response contains a collection of identity providers, which may include both OIDC and SAML identity providers.

idstring uuid

Contains a unique identifier used for this resource.

type'oidc' | 'saml'

Specifies the type of identity provider.

enabledboolean

Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC.

created_atstring date-time

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time

An ISO-8601 timestamp representation of entity update date.

Example response

[
  {
    "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
    "type": "oidc",
    "enabled": true,
    "config": {
      "issuer_url": "https://konghq.okta.com/oauth2/default",
      "client_id": "YOUR_CLIENT_ID",
      "client_secret": "YOUR_CLIENT_SECRET",
      "claim_mappings": {
        "name": "name",
        "email": "email",
        "groups": "groups"
      }
    },
    "created_at": "2022-11-04T20:10:06.927Z",
    "updated_at": "2022-11-04T20:10:06.927Z"
  }
]

Changes

  • 68d43091b84dRevision changes
    • warning

      added the new 403.00 enum value to the response property for the response status

  • f324fb7610e4Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status