Get-ADFSClaimsProviderTrust
Get-ADFSClaimsProviderTrust
Gets the claims provider trusts in the Federation Service.
Syntax
Get-ADFSClaimsProviderTrust [-Identifier] <string[]> [<CommonParameters>]
Identifier
Get-ADFSClaimsProviderTrust [-Name <string[]>] []
Name
Get-ADFSClaimsProviderTrust [[-Certificate] <X509Certificate2[]>] []
Certificate
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
Specifies the token-signing certificate of the claims provider trust to retrieve.
Default Value: **
Data Type: X509Certificate2[]
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
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 |
Identifier
Specifies the unique identifier of the claims provider 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 claims provider 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? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
true |
variableLength |
Input Type
None
Return Type
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. In other words, a claims provider represents the organization for whose users the claims provider issues security tokens 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 can be presented to the relying party across the trust.
Examples
-------------------------- EXAMPLE 1 --------------------------
Command Prompt: C:\PS>
Get-ADFSClaimsProviderTrust -name "My claims provider"
Description
-----------
Gets the current property settings for a specified claims provider trust named "My claims provider".
See Also
Reference
Remove-ADFSClaimsProviderTrust
Set-ADFSClaimsProviderTrust
Enable-ADFSClaimsProviderTrust
Disable-ADFSClaimsProviderTrust
Update-ADFSClaimsProviderTrust