Redigera

Dela via

Get-AdfsClaimDescription

  • Reference
Module:
ADFS

Gets claim descriptions from the Federation Service.

Syntax

Get-AdfsClaimDescription
   [[-Name] <String[]>]
   [<CommonParameters>]
Get-AdfsClaimDescription
   -ClaimType <String[]>
   [<CommonParameters>]
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.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies an array of names of claim descriptions to get.

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ShortName

Specifies the unique short name ID for the claim description that is used for issuing and consuming JWT tokens.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

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).