identityProvider 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 identity providers with External Identities for both Azure Active Directory tenant and an Azure AD B2C tenant.

For Azure AD B2B scenarios in an Azure AD tenant, the identity provider type can be Google or Facebook.

Configuring an identity provider in your Azure AD tenant enables new Azure AD 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, Twitter or any openIdConnectProvider. 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 or a custom OpenID Connect 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 or their own custom identity provider that complies with OIDC protocol.

If it is a custom OpenID Connect identity provider with OpenIDConnect as type then it is represented using openIdConnectProvider resource type, which will inherit from identityProvider resource type.

Methods

Method Return Type Description
List identityProvider collection Retrieve all identity providers configured in a tenant.
Create identityProvider Create a new identity provider.
Get identityProvider Retrieve properties of an identity provider.
Update None Update an identity provider.
Delete None Delete an identity provider.
List available provider types String collection Retrieve all available identity provider types.

Properties

Property Type Description
clientId String The client ID for the application obtained when registering the application with the identity provider. This is a required field.
clientSecret String The client secret for the application obtained when registering the application with the identity provider. This is write-only. A read operation will return "****". This is a required field.
id String The ID of the identity provider.
name String The display name of the identity provider.
type String The identity provider type is a required field.
    For B2B scenario:
  • Google
  • Facebook
    For B2C scenario:
  • Microsoft
  • Google
  • Amazon
  • LinkedIn
  • Facebook
  • GitHub
  • Twitter
  • Weibo
  • QQ
  • WeChat
  • OpenIDConnect

Where to get the client ID 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 ID 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 Azure AD before the tenant issues a token to the application.

JSON representation

The following is a JSON representation of the resource.

{
    "id": "String",
    "type": "String",
    "name": "String",
    "clientId": "String",
    "clientSecret": "String"
}