Update-Adfs Relying Party Trust

Module:
adfs
Updates the relying party trust from federation metadata.

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>]

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.

Examples

Example 1: Update a relying party trust 

PS C:\> Update-ADFSRelyingPartyTrust -TargetName "FarikamApp"

This command updates the relying party trust named FabrikamApp.

Required Parameters

-TargetIdentifier

Specifies the identifier of the relying party trust to update.

Type: String
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-TargetName

Specifies the name of the relying party trust to update.

Type: String
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-TargetRelyingParty

Specifies a RelyingPartyTrust object. The cmdlet updates the relying party trust that you specify. To obtain a RelyingPartyTrust object, use the Get-AdfsRelyingPartyTrust cmdlet.

Type: RelyingPartyTrust
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-MetadataFile

Specifies a file path in UNC format. The file that you specify contains the federation metadata for the relying party application.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Aliases: wi
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Inputs

Microsoft.IdentityServer.PowerShell.Resources.RelyingPartyTrust

A class structure that represents a relying party trust.

Outputs

None

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.