Get-AdfsRelyingPartyTrust
Gets the relying party trusts of the Federation Service.
Syntax
RelyingPartyName (Default)
Get-AdfsRelyingPartyTrust
[[-Name] <String[]>]
[<CommonParameters>]
Identifier
Get-AdfsRelyingPartyTrust
[-Identifier] <String[]>
[<CommonParameters>]
PrefixIdentifier
Get-AdfsRelyingPartyTrust
[-PrefixIdentifier] <String>
[<CommonParameters>]
Description
The Get-AdfsRelyingPartyTrust cmdlet gets the relying party trusts of the Federation Service. You can use this cmdlet with no parameters to get all relying party trust objects.
Examples
Example 1: Get property settings for a relying party trust by using a name
PS C:\> Get-AdfsRelyingPartyTrust -Name "FabrikamApp"
This command gets the property settings for the relying party trust named FabrikamApp.
Example 2: Get property settings for a relying party trust by using an identifier
PS C:\> Get-AdfsRelyingPartyTrust -Identifier "https://FabrikamApp.CentralServer.org"
This command gets the property settings for a relying party trust that has the identifier https://FabrikamApp.CentralServer.org.
Example 3: Get property settings for an updated relying party trust
PS C:\> Get-AdfsRelyingPartyTrust | Where-Object{ $_.LastUpdateTime -le (get-date).subtract((new-timespan -hours 24))}
This command gets the property settings for relying party trusts that have been updated in the last 24 hours.
Parameters
-Identifier
Specifies an array of unique identifiers of the relying party trust to get.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Identifier
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the display name of the relying party trust to get.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
RelyingPartyName
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-PrefixIdentifier
Specifies a prefix identifier of the relying party trust to get. The Federation Service uses prefix matching to support wildcard-type filtering and perform matches based on a specific prefix URL. The Federation Service performs matches by using string data type evaluation. Matches are not case-sensitive.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PrefixIdentifier
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| 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.
Inputs
String
String objects are received by the Identifier, Name, and PrefixIdentifier parameters.
Outputs
Microsoft.IdentityServer.PowerShell.Resources.RelyingPartyTrust
Returns one or more RelyingPartyTrust objects that represent the relying party trust resources for the Federation Service.
Notes
- If no Identifier parameter is provided, the cmdlet returns all RelyingPartyTrust objects. 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 AD FS 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.