List identityProviders

Namespace: microsoft.graph

Get a collection of identity provider resources that are configured for a tenant, and that are derived from identityProviderBase.

For an Azure AD tenant, the providers can be socialIdentityProvider or builtinIdentityProvider objects.

For an Azure AD B2C, the providers can be socialIdentityProvider objects.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) IdentityProvider.Read.All, IdentityProvider.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application IdentityProvider.Read.All, IdentityProvider.ReadWrite.All

The work or school account needs to belong to one of the following roles:

  • Global Administrator
  • External Identity Provider Administrator
  • External ID user flow administrator

HTTP request

GET /identity/identityProviders

Request headers

Name Description
Authorization Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of socialIdentityProvider and/or builtinIdentityProvider objects in the response body for an Azure AD tenant.

For an Azure AD B2C tenant this method returns a 200 OK response code and a collection of socialIdentityProvider objects in the response body.

Examples

Example 1: List all identity provider resources configured in an Azure AD tenant

Request

The following is an example of the request.

GET https://graph.microsoft.com/v1.0/identity/identityProviders

Response

The following is an example of the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/identityProviders",
   "value":[
      {
         "@odata.type": "microsoft.graph.builtInIdentityProvider",
         "id": "MSASignup-OAUTH",
         "identityProviderType": "MicrosoftAccount",
         "displayName": "MicrosoftAccount"
      },
      {
         "@odata.type": "#microsoft.graph.socialIdentityProvider",
         "id": "Facebook-OAUTH",
         "displayName": "Facebook",
         "identityProviderType": "Facebook",
         "clientId": "test",
         "clientSecret": "******"
      }
   ]
}

Example 2: List all identity provider resources configured in an Azure AD B2C tenant

Request

The following is an example of the request.

GET https://graph.microsoft.com/v1.0/identity/identityProviders

Response

The following is an example of the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/identityProviders",
    "value": [
        {
            "@odata.type": "#microsoft.graph.socialIdentityProvider",
            "id": "LinkedIn-OAUTH",
            "displayName": "linkedin",
            "identityProviderType": "LinkedIn",
            "clientId": "866xc0qtyy00ih",
            "clientSecret": "******"
        }
    ]
}