Get-ADFSClaimsProviderTrust
Get-ADFSClaimsProviderTrust
Gets the claims provider trusts in the Federation Service.
Syntax
Parameter Set: ClaimsProviderName
Get-ADFSClaimsProviderTrust [[-Name] <String[]> ] [ <CommonParameters>]
Parameter Set: Identifier
Get-ADFSClaimsProviderTrust [-Identifier] <String[]> [ <CommonParameters>]
Parameter Set: TokenSigningCertificates
Get-ADFSClaimsProviderTrust [-Certificate] <X509Certificate2[]> [ <CommonParameters>]
Detailed Description
The Get-ADFSClaimsProviderTrust cmdlet retrieves the claims provider trusts in the Federation Service. You can use this cmdlet with no parameters to get all the claims provider trust objects.
Parameters
-Certificate<X509Certificate2[]>
Specifies the token-signing certificate of the claims provider trust to retrieve.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Identifier<String[]>
Specifies the unique identifier of the claims provider trust to retrieve.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies the display name of the claims provider trust to retrieve.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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.ClaimsProviderTrust
A class structure that represents the claims provider trusts for the Federation Service.
Notes
- If no target parameter is provided, all claims providers are listed. The claims provider collects and authenticates a user's credentials, builds up claims for that user, and packages the claims into security tokens or Information Cards. In other words, a claims provider represents the organization for whose users the claims provider issues security tokens or Information Cards on their behalf. When you configure Active Directory Federation Services (AD FS) 2.0, the role of the claims provider is to enable its users to access resources that are hosted in a relying party organization by establishing one side of the federation trust relationship. After the federation trust is established, tokens and Information Cards can be presented to the relying party across the trust.
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
Gets the current property settings for a specified claims provider trust named "My claims provider".
C:\PS>Get-ADFSClaimsProviderTrust -name "My claims provider"
Related topics
Disable-ADFSClaimsProviderTrust
Enable-ADFSClaimsProviderTrust