identityProviderBase 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 for both Microsoft Entra and Azure AD B2C tenants.
Configuring an identity provider in your workforce tenant enables new 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.
Configuring an identity provider in your external or 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 Entra External ID or 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 (Open ID Connect is currently supported only with external tenants and Azure AD B2C).
Supported IdPs (types derived from identityProviderBase) | External tenant | Workforce tenant | Azure AD B2C tenant |
---|---|---|---|
appleManagedIdentityProvider | |||
builtInIdentityProvider | |||
socialIdentityProvider | |||
oidcIdentityProvider | |||
openIdConnectIdentityProvider |
Methods
Method | Return Type | Description |
---|---|---|
List configured identity providers | identityProviderBase collection | Retrieve all identity providers configured in a tenant. |
Create | socialidentityprovider, appleManagedIdentityProvider, oidcIdentityProvider or openIdConnectIdentityProvider | Create a new object of one of the following object types:
|
Get | socialidentityprovider, appleManagedIdentityProvider, builtInIdentityProvider, oidcIdentityProvider or openIdConnectIdentityProvider | 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 identity providers | String collection | Retrieve all supported identity provider types in the tenant. |
Properties
Property | Type | Description |
---|---|---|
id | String | The identifier of the identity provider. |
displayName | String | The display name of the identity provider. |
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"id": "String",
"displayName": "String",
}