Skip to main content
GET
/
identity-providers
TypeScript
import { MyOrganizationClient } from "github.com/auth0/myorganization-js";

async function main() {
    const client = new MyOrganizationClient({
        token: "<token>",
    });
    await client.organization.identityProviders.list();
}
main();
{
  "identity_providers": [
    {
      "id": "con_zW1UHutvkVWSWdCC",
      "name": "oidcIdp",
      "display_name": "OIDC IdP",
      "strategy": "oidc",
      "show_as_button": true,
      "assign_membership_on_login": false,
      "access_level": "full",
      "domains": [
        "mydomain.com"
      ],
      "is_enabled": true,
      "options": {
        "type": "front_channel",
        "client_id": "a8f3b2e7-5d1c-4f9a-8b0d-2e1c3a5b6f7d",
        "discovery_url": "https://{yourDomain}/.well-known/openid-configuration"
      },
      "attributes": [
        {
          "sso_field": [
            "userName"
          ],
          "user_attribute": "preferred_username",
          "description": "Preferred Username",
          "label": "Preferred username",
          "is_required": true,
          "is_extra": false,
          "is_missing": false
        },
        {
          "sso_field": [
            "externalId"
          ],
          "user_attribute": "external_id",
          "is_required": true,
          "is_extra": true,
          "is_missing": false
        }
      ]
    },
    {
      "id": "con_zW1UHutvkVWSWdCD",
      "name": "samlIdp",
      "display_name": "Saml IdP",
      "strategy": "samlp",
      "show_as_button": true,
      "assign_membership_on_login": false,
      "access_level": "limited",
      "domains": [
        "mydomain.com"
      ],
      "is_enabled": true,
      "options": {
        "signatureAlgorithm": "rsa-sha256",
        "digestAlgorithm": "sha256",
        "protocolBinding": "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST",
        "signSAMLRequest": true,
        "bindingMethod": "HTTP-Redirect",
        "metadataUrl": "a.metadata.url",
        "cert": "MIIDQjCCAiugAwIBAgIRAMp+cW+SgQ2Yh7fF8v8b0OQwDQYJKoZIhvcNAQELBQAw...",
        "idpInitiated": {
          "enabled": true,
          "client_id": "a8f3b2e7-5d1c-4f9a-8b0d-2e1c3a5b6f7d",
          "client_protocol": "SAML",
          "client_authorizequery": "redirect_uri=https://jwt.io&scope=openid email&response_type=token"
        }
      },
      "attributes": [
        {
          "sso_field": [
            "userName"
          ],
          "user_attribute": "preferred_username",
          "description": "Preferred Username",
          "label": "Preferred username",
          "is_required": true,
          "is_extra": false,
          "is_missing": false
        },
        {
          "sso_field": [
            "externalId"
          ],
          "user_attribute": "external_id",
          "is_required": true,
          "is_extra": true,
          "is_missing": false
        }
      ]
    }
  ]
}

Release Lifecycle

Beta

Scopes

Scopes define permissions and access levels for API requests and authentication tokens.
read:my_org:identity_providers

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Response

List of identity providers successfully retrieved.

identity_providers
(IdP ADFS Response · object | IdP Google Workforce Response · object | IdP OIDC Response · object | IdP Okta Response · object | IdP Ping Response · object | IdP SAML Response · object | IdP Microsoft Azure AD Response · object)[]

Identity provider specific options.