Get-ADFSClaimDescription

  • Article

Get-ADFSClaimDescription

Gets claim descriptions that are in the Federation Service.

Syntax

Parameter Set: Name
Get-ADFSClaimDescription [[-Name] <String[]> ] [ <CommonParameters>]

Parameter Set: Identifier
Get-ADFSClaimDescription -ClaimType <String[]> [ <CommonParameters>]

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<String[]>

Specifies the claim type of the claim description to retrieve.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Name<String[]>

Specifies the name of the claim description to retrieve.

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

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

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

Outputs

The output type is the type of the objects that the cmdlet emits.

  • 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 --------------------------

Description

-----------

Gets the list of claim descriptions that the Federation Service offers.

C:\PS>Get-ADFSClaimDescription | Where -Object {$_.IsOffered}

Add-ADFSClaimDescription

Remove-ADFSClaimDescription

Set-ADFSClaimDescription