Get-EntraIdentityProvider

This cmdlet is used to retrieve the configured identity providers in the directory.

Syntax

Get-EntraIdentityProvider
   [-Property <String[]>]
   [<CommonParameters>]
Get-EntraIdentityProvider
   -IdentityProviderBaseId <String>
   [-Property <String[]>]
   [<CommonParameters>]

Description

The Get-EntraIdentityProvider cmdlet is used to retrieve the identity providers that have been configured in the directory. These identity providers can be used to allow users to sign up for or sign into applications secured by Microsoft Entra ID B2C.

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

The current set of identity providers can be Microsoft, Google, Facebook, Amazon, or LinkedIn.

Examples

Example 1: Retrieve all identity providers

Connect-Entra -Scopes 'IdentityProvider.Read.All'
Get-EntraIdentityProvider

Id                   DisplayName
--                   -----------
AADSignup-OAUTH      Directory Sign up
Google-OAUTH         Test
EmailOtpSignup-OAUTH Email One Time Passcode
MSASignup-OAUTH      Microsoft Account

This example retrieves the list of all configured identity providers and their properties.

Example 2: Retrieve identity provider by Id

Connect-Entra -Scopes 'IdentityProvider.Read.All'
Get-EntraIdentityProvider -IdentityProviderBaseId Google-OAUTH

Id           DisplayName
--           -----------
Google-OAUTH GoogleName

This example retrieves the properties for the specified identity provider.

  • -IdentityProviderBaseId parameter specifies the unique identifier of the identity provider.

Parameters

-IdentityProviderBaseId

The unique identifier for an identity provider.

Type:System.String
Aliases:Id
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Property

Specifies properties to be returned.

Type:System.String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

System.String

Outputs

System.Object