Sign in
Auth Settings

Get 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.

get/v3/identity-providers/{id}

Response

An identity provider configuration. This response represents the configuration of a specific identity provider, which can be either OIDC or SAML.

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.

login_pathstring

The path used for initiating login requests with the identity provider.

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,
  "login_path": "myapp",
  "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

Changed in 3 of the 52 revisions of this API.23

  • 72502a676a922See the full diff
    • ○

      the idp_metadata_url response's property default value was added for the status 200

      response-property-default-value-added

    • ○

      the idp_metadata_xml response's property default value was added for the status 200

      response-property-default-value-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 0bf5f988349f2See the full diff
    • ▲

      the config/oneOf[subschema #2: SAML Identity Provider Config]/callback_url response's property type/format changed from string/path to string/uri for status 200

      response-property-type-changed

    • ▲

      the config/oneOf[subschema #2: SAML Identity Provider Config]/sp_metadata_url response's property type/format changed from string/path to string/uri for status 200

      response-property-type-changed

  • d1aa59a0a1151See the full diff
    • ○

      endpoint added

      endpoint-added