Get-ADFSRelyingPartyTrust
Get-ADFSRelyingPartyTrust
Gets the relying party trusts of the Federation Service.
Syntax
Get-ADFSRelyingPartyTrust [-Identifier] <string[]> [<CommonParameters>]
Identifier
Get-ADFSRelyingPartyTrust [[-Name] <string[]>] []
Name
Get-ADFSRelyingPartyTrust [-PrefixIdentifier ] []
PrefixIdentifier
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
Specifies the unique identifier of the relying party trust to retrieve.
Default Value: **
Data Type: string[]
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
true |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
true (ByValue) |
pipelineInput |
Position? |
1 |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
true |
variableLength |
Name
Specifies the display name of the relying party trust to retrieve.
Default Value: **
Data Type: string[]
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
true |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
pipelineInput |
Position? |
1 |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
true |
variableLength |
PrefixIdentifier
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.
Default Value: **
Data Type: string
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Input Type
None
Return Type
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 --------------------------
Command Prompt: C:\PS>
Get-ADFSRelyingPartyTrust -Name SampleApp
Description
-----------
Gets the current property settings for a relying party trust that is specified by name SampleApp.
-------------------------- EXAMPLE 2 --------------------------
Command Prompt: C:\PS>
Get-ADFSRelyingPartyTrust -Identifier https://SampleApp.SampleServer.org
Description
-----------
Gets the current property settings for a relying party trust that is specified by the identifier https://SampleApp.SampleServer.org.
-------------------------- EXAMPLE 3 --------------------------
Command Prompt: C:\PS>
Get-ADFSRelyingPartyTrust | Where-Object{ $_.LastUpdateTime -le (get-date).subtract((new-timespan -hours 24))}
Description
-----------
Gets the current property settings for any relying party trusts that have been updated within the last 24 hours.
See Also
Reference
Add-ADFSRelyingPartyTrust
Remove-ADFSRelyingPartyTrust
Set-ADFSRelyingPartyTrust
Enable-ADFSRelyingPartyTrust
Disable-ADFSRelyingPartyTrust
Update-ADFSRelyingPartyTrust