Add-ADFSClaimDescription

  • Article

Add-ADFSClaimDescription

Adds a claim description to the Federation Service.

Syntax

Add-ADFSClaimDescription -ClaimType <Uri> -IsAccepted <Boolean> -IsOffered <Boolean> -IsRequired <Boolean> -Name <string> [-Notes <string>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]

  • ClaimType

  • IsAccepted

  • IsOffered

  • IsRequired

  • Name

  • Notes

  • PassThru

  • Confirm

  • WhatIf

Detailed Description

The Add-ADFSClaimDescription cmdlet adds a claim description to the Federation Service.

Parameters

ClaimType

Specifies the claim type URN or URI of the claim. All claim descriptions must include a valid URN or URI.

Default Value: false

Data Type: Uri

Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

IsAccepted

Specifies that the claim should be published in federation metadata as a claim that the Federation Service accepts.

Default Value: false

Data Type: Boolean

Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

IsOffered

Specifies that the claim should be published in federation metadata as a claim that the Federation Service offers.

Default Value: false

Data Type: Boolean

Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

IsRequired

Specifies that the claim should be published in federation metadata as a claim that the Federation Service requires.

Default Value: false

Data Type: Boolean

Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Name

Specifies the friendly name of this claim.

Default Value: **

Data Type: string

Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Notes

Specifies any notes for this claim description.

Default Value: **

Data Type: string

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

PassThru

Passes an object to the pipeline. By default, this cmdlet does not generate any output.

Default Value: **

Data Type: SwitchParameter

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Confirm

Prompts you for confirmation before executing the command.

Default Value: **

Data Type: SwitchParameter

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

true

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

WhatIf

Describes what would happen if you executed the command without actually executing the command.

Default Value: **

Data Type: SwitchParameter

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

true

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Input Type

None

Return Type

None

Notes

  • You can use claim descriptions to configure the list of claims that are available to be offered or accepted by AD FS 2.0.

Examples

-------------------------- EXAMPLE 1 --------------------------

Command Prompt: C:\PS>

 
Add-ADFSClaimDescription -name "Role" -ClaimType "https://fabrikam.com/role"

Description

-----------

Adds a new claim description for a custom Role claim.

See Also

Reference

Get-ADFSClaimDescription
Remove-ADFSClaimDescription
Set-ADFSClaimDescription

Other Resources

Online version: