Get-AdfsClaimDescription is accessible with the help of adfs module. To install adfs on your system please refer to this adfs.
Synopsis
Gets claim descriptions from the Federation Service.
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.
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.
Required? true
Position? named
Default value none
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Name <String[]>
Specifies an array of names of claim descriptions to get.
Required? false
Position? 1
Default value none
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-ShortName <String[]>
Specifies the unique short name ID for the claim description that is used for issuing and consuming JWT tokens.
Required? true
Position? named
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
Syntax
Get-AdfsClaimDescription [[-Name] <String[]>] [<CommonParameters>]
Get-AdfsClaimDescription -ClaimType <String[]> [<CommonParameters>]
Get-AdfsClaimDescription -ShortName <String[]> [<CommonParameters>]
Notes
Use claim descriptions to configure the list of claims available to be offered or accepted by Active Directory Federation Services (AD FS) 2.0.
———————-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.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Get-AdfsClaimDescription
You can also read about
- Add-AdfsClaimDescription
- Remove-AdfsClaimDescription
- Set-AdfsClaimDescription