Edit

identityProviderBase resource type

  • Article

Namespace: microsoft.graph

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

For Microsoft Entra B2B scenarios in a Microsoft Entra directory, the identity provider can be a socialIdentityProvider or a builtinIdentityProvider, both of which inherit from the identityProviderBase resource type.

Configuring an identity provider in your Microsoft Entra directory 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 directory, the identity provider type can be a socialIdentityProvider or an appleManagedIdentityProvider, all which inherit from the identityProviderBase resource type.

Configuring an identity provider in your Azure AD B2C directory 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.

Methods

Method Return Type Description
List identityProviderBase collection Retrieve all identity providers configured in a tenant.
Create socialidentityprovider or appleManagedIdentityProvider Create a new object of one of the following object types:
Get socialidentityprovider, builtInIdentityProvider or appleManagedIdentityProvider Retrieve properties of one of the following object types:
Update None Update one of the following object types:
Delete None Delete one of the following object types:
List available provider types String collection Retrieve all supported identity provider types in the tenant.

Properties

Property Type Description
displayName String The display name of the identity provider.
id String The identifier of the identity provider.

JSON representation

The following is a JSON representation of the resource.

{
    "id": "String",
    "displayName": "String"
}