Get-AdfsClaimDescription
Gets claim descriptions from the Federation Service.
Syntax
Name (Default)
Get-AdfsClaimDescription
[[-Name] <String[]>]
[<CommonParameters>]
Identifier
Get-AdfsClaimDescription
-ClaimType <String[]>
[<CommonParameters>]
ShortName
Get-AdfsClaimDescription
-ShortName <String[]>
[<CommonParameters>]
Description
The Get-AdfsClaimDescription cmdlet gets claim descriptions from the Federation Service. Claim descriptions describe the claims that the Federation Service uses. Claim descriptions also describe how claims are published in federation metadata. You can use this cmdlet without parameters to get all claim descriptions in the Federation Service.
Examples
Example 1: Get a claim description
PS C:\> Get-AdfsClaimDescription | Where-Object {$_.IsOffered}
This command gets the list of claim descriptions that the Federation Service offers.
Parameters
-ClaimType
Specifies an array of claim type URNs or URIs of the claim. The cmdlet gets the claim descriptions for the claims that you specify.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Identifier
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies an array of names of claim descriptions to get.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Name
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ShortName
Specifies the unique short name ID for the claim description that is used for issuing and consuming JWT tokens.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ShortName
| Position: | Named |
| 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 ClaimType, Name, and ShortName parameters.
Outputs
Microsoft.IdentityServer.PowerShell.Resources.ClaimDescription
Returns one or more ClaimDescription objects that represent the claim description resources for the Federation Service.
Notes
- Use claim descriptions to configure the list of claims available to be offered or accepted by Active Directory Federation Services (AD FS).