List identityProviders
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Get a collection of identity provider resources that are configured for a tenant, and that are derived from identityProviderBase.
For a Microsoft Entra tenant, the providers can be socialIdentityProviders or builtinIdentityProviders objects.
For an Azure AD B2C, the providers can be socialIdentityProvider, openIdConnectIdentityProvider, or appleManagedIdentityProvider objects.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | IdentityProvider.Read.All | IdentityProvider.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | IdentityProvider.Read.All | IdentityProvider.ReadWrite.All |
In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. External Identity Provider Administrator is the least privileged role supported for this operation.
HTTP request
GET /identity/identityProviders
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a collection of socialIdentityProvider, or builtinIdentityProvider objects in the response body for a Microsoft Entra tenant.
For an Azure AD B2C tenant this method returns a 200 OK
response code and a collection of socialIdentityProvider, openIdConnectIdentityProvider, or appleManagedIdentityProvider objects in the response body.
Examples
Example 1: List all identity provider resources configured in a Microsoft Entra tenant
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/identity/identityProviders
Response
The following example shows 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/beta/$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 providers configured in an Azure AD B2C tenant
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/identity/identityProviders
Response
The following example shows 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/beta/$metadata#identity/identityProviders",
"value": [
{
"@odata.type": "#microsoft.graph.socialIdentityProvider",
"id": "LinkedIn-OAUTH",
"displayName": "linkedin",
"identityProviderType": "LinkedIn",
"clientId": "866xc0qtyy00ih",
"clientSecret": "******"
},
{
"@odata.type": "#microsoft.graph.openIdConnectIdentityProvider",
"id": "OIDC-V1-rtt_AD_Test-3e393390-ed2d-4794-97f6-5c1a1ccc61f7",
"displayName": "OIDC AD Test",
"clientId": "fe1b3476-rdca-4bef-b321-076fde19750b",
"clientSecret": "******",
"scope": "openid",
"metadataUrl": "https://login.microsoftonline.com/contoso.com/.well-known/openid-configuration",
"domainHint": "",
"responseType": "code",
"responseMode": "form_post",
"claimsMapping": {
"userId": "oid",
"displayName": "name",
"givenName": "given_name",
"surname": "family_name",
"email": "unique_email"
}
},
{
"@odata.type": "#microsoft.graph.appleManagedIdentityProvider",
"id": "Apple-Managed-OIDC",
"displayName": "Sign in with Apple",
"developerId": "UBF8T346G9",
"serviceId": "com.microsoft.aad.b2c.iuyt.client",
"keyId": "99P6DD87C4",
"certificateData": "******"
}
]
}
Example 3: List all identity providers configured in a Microsoft Entra External ID in an external tenant
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/identity/identityProviders
Response
The following example shows 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/beta/$metadata#identity/identityProviders",
"@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET identity/identityProviders?$select=displayName",
"value": [
{
"@odata.type": "#microsoft.graph.builtInIdentityProvider",
"id": "AADSignup-OAUTH",
"displayName": "Azure Active Directory Sign up",
"identityProviderType": "AADSignup",
"state": null
},
{
"@odata.type": "#microsoft.graph.builtInIdentityProvider",
"id": "EmailOtpSignup-OAUTH",
"displayName": "Email One Time Passcode",
"identityProviderType": "EmailOTP",
"state": null
},
{
"@odata.type": "#microsoft.graph.builtInIdentityProvider",
"id": "EmailPassword-OAUTH",
"displayName": "Email with password",
"identityProviderType": "EmailPassword",
"state": null
}
]
}