socialIdentityProvider resource type

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.

Represents social identity providers with External Identities for both Microsoft Entra ID and Azure AD B2C tenants.

Inherits from identityProviderBase.

For Microsoft Entra B2B scenarios in a Microsoft Entra tenant, the identity provider type can be Google or Facebook.

Configuring an identity provider in your Microsoft Entra tenant enables new Microsoft Entra B2B guest scenarios. For example, an organization has resources in Microsoft 365 that need to be shared with a Gmail user. The Gmail user will use their Google account credentials to authenticate and access the documents.

In an Azure AD B2C tenant, the identity provider type can be Microsoft, Google, Facebook, Amazon, LinkedIn or Twitter. The following identity providers are in preview: Weibo, QQ, WeChat, and GitHub.

Configuring an identity provider in your Azure AD B2C tenant enables users to sign up and sign in using a social account supported provider in an application. For example, an application can use Azure AD B2C to allow users to sign up for the service using a Facebook account.

Methods

Method	Return Type	Description
List	identityProviderBase collection	Retrieve all identity providers configured in a tenant including the socialIdentityProvider object types. There is no way to retrieve only the social identity providers in a tenant.
Create	socialidentityprovider	Create a new socialIdentityProvider object.
Get	socialidentityprovider	Retrieve properties of a socialIdentityProvider object.
Update	None	Update a socialIdentityProvider object.
Delete	None	Delete a socialIdentityProvider object.
List available provider types	String collection	Retrieve all available identity provider types available in the tenant.

Properties

Property	Type	Description
clientId	String	The client identifier for the application obtained when registering the application with the identity provider. Required.
clientSecret	String	The client secret for the application that is obtained when the application is registered with the identity provider. This is write-only. A read operation returns ****. Required.
id	String	The identifier of the identity provider. Inherited from identityProviderBase. Read-only.
displayName	String	The display name of the identity provider. Inherited from identityProviderBase.
identityProviderType	String	For a B2B scenario, possible values: Google, Facebook. For a B2C scenario, possible values: Microsoft, Google, Amazon, LinkedIn, Facebook, GitHub, Twitter, Weibo, QQ, WeChat. Required.

Where to get the client identifier and secret

Each identity provider has a process for creating an app registration. For example, users create an app registration with Facebook at developers.facebook.com. The resulting client identifier and client secret can be passed to create identityProvider. Then, each user object in the directory can be federated to any of the tenant's identity providers for authentication. This enables the user to sign in by entering credentials on the identity provider's sign-in page. The token from the identity provider is validated by Microsoft Entra ID before the tenant issues a token to the application.

JSON representation

The following is a JSON representation of the resource.

{
    "id": "String",
    "identityProviderType": "String",
    "displayName": "String",
    "clientId": "String",
    "clientSecret": "String"
}