Update-ADFSRelyingPartyTrust

Update-ADFSRelyingPartyTrust

Updates the relying party trust from federation metadata.

Syntax

Parameter Set: Identifier
Update-ADFSRelyingPartyTrust -TargetIdentifier <String> [-MetadataFile <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: IdentifierName
Update-ADFSRelyingPartyTrust -TargetName <String> [-MetadataFile <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: IdentifierObject
Update-ADFSRelyingPartyTrust -TargetRelyingParty <RelyingPartyTrust> [-MetadataFile <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Update-ADFSRelyingPartyTrust cmdlet updates the relying party trust from the federation metadata that is available at the federation metadata URL. This cmdlet updates claims, endpoints, and certificates.

Parameters

-MetadataFile<String>

-PassThru

Passes an object to the pipeline. By default, this cmdlet does not generate any output.

-TargetIdentifier<String>

Specifies the identifier of the relying party trust to update.

-TargetName<String>

Specifies the name of the relying party trust to update.

-TargetRelyingParty<RelyingPartyTrust>

Specifies the relying party trust to update. This value is typically taken from the pipeline.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

• Microsoft.IdentityServer.PowerShell.Resources.RelyingPartyTrust

  A class structure that represents a relying party trust.

Outputs

The output type is the type of the objects that the cmdlet emits.

• None

Notes

• A relying party in Active Directory Federation Services (AD FS) 2.0 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 AD FS 2.0 is configured 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.

Examples

-------------------------- EXAMPLE 1 --------------------------

Description

-----------

Updates a relying party trust object.

C:\PS>Update-ADFSRelyingPartyTrust -TargetName "Sample App"

Related topics

Add-ADFSRelyingPartyTrust

Disable-ADFSRelyingPartyTrust

Enable-ADFSRelyingPartyTrust

Get-ADFSRelyingPartyTrust

Remove-ADFSRelyingPartyTrust

Set-ADFSRelyingPartyTrust