Update-AdfsRelyingPartyTrust
Update-AdfsRelyingPartyTrust is accessible with the help of adfs module. To install adfs on your system please refer to this adfs.
Synopsis
Updates the relying party trust from federation metadata.
Description
The Update-AdfsRelyingPartyTrust cmdlet updates the relying party trust from the federation metadata that is available at the federation metadata URL. The cmdlet updates claims, endpoints, and certificates.
Parameters
-MetadataFile
Specifies a file path in UNC format. The file that you specify contains the federation metadata for the relying party application.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-PassThru <SwitchParameter>
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-TargetIdentifier <String>
Specifies the identifier of the relying party trust to update.
Required? true
Position? named
Default value none
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-TargetName <String>
Specifies the name of the relying party trust to update.
Required? true
Position? named
Default value none
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-TargetRelyingParty <RelyingPartyTrust>
Specifies a RelyingPartyTrust object. The cmdlet updates the relying party trust that you specify. To obtain a RelyingPartyTrust object, use the Get-AdfsRelyingPartyTrust cmdlet.
Required? true
Position? named
Default value none
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Confirm <SwitchParameter>
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf <SwitchParameter>
Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
Syntax
Update-AdfsRelyingPartyTrust [-MetadataFile <String>] -TargetIdentifier <String> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
Update-AdfsRelyingPartyTrust [-MetadataFile <String>] -TargetRelyingParty <RelyingPartyTrust> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
Update-AdfsRelyingPartyTrust [-MetadataFile <String>] -TargetName <String> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
Notes
A relying party in Active Directory Federation Services (AD FS) is an organization in which Web servers that host one or more Web-based applications reside. Tokens and Information Cards that originate from a claims provider can then be presented and ultimately consumed by the Web-based resources that are located in the relying party organization. When you configure AD FS in the role of the relying party, it acts as a partner that trusts a claims provider to authenticate users. Therefore, the relying party consumes the claims that are packaged in security tokens that come from users in the claims provider. In other words, a relying party is the organization whose Web servers are protected by the resource-side federation server. The federation server at the relying party uses the security tokens that the claims provider produces to issue tokens to the Web servers that are located in the relying party.
————————Example 1————————
Update a relying party trust
PS C:> Update-ADFSRelyingPartyTrust -TargetName “TOSSApp”
This command updates the relying party trust named TOSSApp.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Update-AdfsRelyingPartyTrust
You can also read about
- Add-AdfsRelyingPartyTrust
- Disable-AdfsRelyingPartyTrust
- Enable-AdfsRelyingPartyTrust
- Get-AdfsRelyingPartyTrust
- Remove-AdfsRelyingPartyTrust
- Set-AdfsRelyingPartyTrust