Set-EntraIdentityProvider
Update the properties of an existing identity provider configured in the directory.
Syntax
Default (Default)
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.
In delegated scenarios using work or school accounts, the signed-in user must have a Microsoft Entra role or custom role with the necessary permissions. The following least privileged roles support this operation:
- External Identity Provider Administrator
Examples
Example 1: Update client id of an identity provider
Connect-Entra -Scopes 'IdentityProvider.ReadWrite.All'
Set-EntraIdentityProvider -IdentityProviderBaseId 'Google-OAuth' -ClientId 'NewClientID'
This example updates the client ID for the specified identity provider.
-Idparameter specifies the unique identifier of the identity provider.-ClientIdparameter 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'
Set-EntraIdentityProvider -IdentityProviderBaseId 'Google-OAuth' -ClientSecret 'NewClientSecret'
This example updates the client secret for the specified identity provider.
-Idparameter specifies the unique identifier of the identity provider.-ClientSecretparameter 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'
Set-EntraIdentityProvider -IdentityProviderBaseId 'Google-OAuth' -Name 'NewGoogleName'
This example updates the display name for the specified identity provider.
-Idparameter specifies the unique identifier of the identity provider.-Nameparameter 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.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ClientSecret
The client secret for the application, obtained during registration with the identity provider, is write-only. A read operation returns ****.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IdentityProviderBaseId
The unique identifier for an identity provider.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Id |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Name
The display name of the identity provider.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.