Get-ADFSClaimDescription
Get-ADFSClaimDescription
Gets claim descriptions that are in the Federation Service.
Syntax
Get-ADFSClaimDescription [[-ClaimType] <Uri[]>] [<CommonParameters>]
ClaimType
Get-ADFSClaimDescription [[-Name] <string[]>] []
Name
Detailed Description
The Get-ADFSClaimDescription cmdlet retrieves the claim descriptions that are in the Federation Service. Claim descriptions describe the claims that the Federation Service uses. They also describe how these claims are published in federation metadata. You can use this cmdlet without parameters to get the full list of claim descriptions.
Parameters
ClaimType
Specifies the claim type of the claim description to retrieve.
Default Value: **
Data Type: Uri[]
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 |
Name
Specifies the name of the claim description 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 |
Input Type
None
Return Type
Microsoft.IdentityServer.PowerShell.Resources.ClaimDescription
A class structure that represents the claim description resources for the Federation Service.
Notes
- Claim descriptions are used to configure the list of claims available to be offered or accepted by AD FS 2.0.
Examples
-------------------------- EXAMPLE 1 --------------------------
Command Prompt: C:\PS>
Get-ADFSClaimDescription | Where -Object {$_.IsOffered}
Description
-----------
Gets the list of claim descriptions that the Federation Service offers.
See Also
Reference
Add-ADFSClaimDescription
Remove-ADFSClaimDescription
Set-ADFSClaimDescription