Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Get-AdfsClaimDescription

Last Updated: 3/8/2017

SYNOPSIS

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.

Type: String[]
Parameter Sets: Identifier
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Specifies an array of names of claim descriptions to get.

Type: String[]
Parameter Sets: Name
Aliases: 

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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[]
Parameter Sets: ShortName
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

Microsoft.IdentityServer.PowerShell.Resources.ClaimDescription

This cmdlet generates a class structure that represents 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) 2.0.

Add-AdfsClaimDescription

Remove-AdfsClaimDescription

Set-AdfsClaimDescription

© 2017 Microsoft