Get-ADFSRelyingPartyTrust

Get-ADFSRelyingPartyTrust

Gets the relying party trusts of the Federation Service.

Syntax

Parameter Set: RelyingPartyName
Get-ADFSRelyingPartyTrust [[-Name] <String[]> ] [ <CommonParameters>]

Parameter Set: Identifier
Get-ADFSRelyingPartyTrust [-Identifier] <String[]> [ <CommonParameters>]

Parameter Set: PrefixIdentifier
Get-ADFSRelyingPartyTrust [-PrefixIdentifier] <String> [ <CommonParameters>]

Detailed Description

The Get-ADFSRelyingPartyTrust cmdlet retrieves the relying party trusts in the Federation Service. You can use this cmdlet with no parameters to get all relying party trust objects.

Parameters

-Identifier<String[]>

Specifies the unique identifier of the relying party trust to retrieve.

-Name<String[]>

Specifies the display name of the relying party trust to retrieve.

-PrefixIdentifier<String>

Specifies a prefix identifier of the relying party trust to retrieve. Prefix matching is used to support wildcard-type filtering and do matches based on a specific prefix URL. Matches are done using string data type evaluation and are not case-sensitive.

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

• None

Outputs

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

• Microsoft.IdentityServer.PowerShell.Resources.RelyingPartyTrust

  A class structure that represents a relying party trust.

Notes

• If no Target* parameter is provided, all RelyingParty objects are returned. 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

-----------

Gets the current property settings for a relying party trust that is specified by name SampleApp.

C:\PS>Get-ADFSRelyingPartyTrust -Name SampleApp

-------------------------- EXAMPLE 2 --------------------------

Description

-----------

Gets the current property settings for a relying party trust that is specified by the identifier https://SampleApp.SampleServer.org.

C:\PS>Get-ADFSRelyingPartyTrust -Identifier https://SampleApp.SampleServer.org

-------------------------- EXAMPLE 3 --------------------------

Description

-----------

Gets the current property settings for any relying party trusts that have been updated within the last 24 hours.

C:\PS>Get-ADFSRelyingPartyTrust | Where-Object{ $_.LastUpdateTime  -le  (get-date).subtract((new-timespan -hours 24))}

Related topics

Add-ADFSRelyingPartyTrust

Disable-ADFSRelyingPartyTrust

Enable-ADFSRelyingPartyTrust

Remove-ADFSRelyingPartyTrust

Set-ADFSRelyingPartyTrust

Update-ADFSRelyingPartyTrust