Edit

Share via

Set-EntraIdentityProvider

  • Reference
Module:
Microsoft.Entra

Update the properties of an existing identity provider configured in the directory.

Syntax

Set-EntraIdentityProvider
   -IdentityProviderBaseId <String>
   [-Type <String>]
   [-ClientSecret <String>]
   [-ClientId <String>]
   [-Name <String>]
   [<CommonParameters>]

Description

The Set-EntraIdentityProvider cmdlet is used to update the properties of an existing identity provider.

The type of the identity provider can't be modified.

Examples

Example 1: Update client id of an identity provider

Connect-Entra -Scopes 'IdentityProvider.ReadWrite.All'
$params = @{
    IdentityProviderBaseId = 'Google-OAuth'
    ClientId = 'NewClientID'
}
Set-EntraIdentityProvider @params

This example updates the client ID for the specified identity provider.

  • -Id parameter specifies the unique identifier of the identity provider.
  • -ClientId parameter specifies the client identifier for the application, obtained during the application's registration with the identity provider.

Example 2: Update client secret of an identity provider

Connect-Entra -Scopes 'IdentityProvider.ReadWrite.All'
$params = @{
    IdentityProviderBaseId = 'Google-OAuth'
    ClientSecret = 'NewClientSecret'
}
Set-EntraIdentityProvider @params

This example updates the client secret for the specified identity provider.

  • -Id parameter specifies the unique identifier of the identity provider.
  • -ClientSecret parameter specifies the client secret for the application, obtained during registration with the identity provider.

Example 3: Update display name of an identity provider

Connect-Entra -Scopes 'IdentityProvider.ReadWrite.All'
$params = @{
    IdentityProviderBaseId = 'Google-OAuth'
    Name = 'NewGoogleName'
}
Set-EntraIdentityProvider @params

This example updates the display name for the specified identity provider.

  • -Id parameter specifies the unique identifier of the identity provider.
  • -Name parameter specifies the display name of the identity provider.

Parameters

-ClientId

The client identifier for the application, obtained during the application's registration with the identity provider.

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

-ClientSecret

The client secret for the application, obtained during registration with the identity provider, is write-only. A read operation returns ****.

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

-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

-Name

The display name of the identity provider.

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

-Type

The identity provider type. It must be one of the following values: Microsoft, Google, Facebook, Amazon, or LinkedIn.

For a B2B scenario, possible values: Google, Facebook. For a B2C scenario, possible values: Microsoft, Google, Amazon, LinkedIn, Facebook, GitHub, Twitter, Weibo, QQ, WeChat.

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

Inputs

System.String

Outputs

System.Object