Set-ADFSClaimDescription

  • Article

Set-ADFSClaimDescription

Sets the properties of an existing claim description.

Syntax

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

  • TargetClaimDescription

  • ClaimType

  • IsAccepted

  • IsOffered

  • IsRequired

  • Name

  • Notes

  • PassThru

  • Confirm

  • WhatIf

    Set-ADFSClaimDescription [-TargetClaimType] <Uri[]> [-ClaimType ] [-IsAccepted ] [-IsOffered ] [-IsRequired ] [-Name ] [-Notes ] [-PassThru] [-Confirm] [-WhatIf] []

  • TargetClaimType

  • ClaimType

  • IsAccepted

  • IsOffered

  • IsRequired

  • Name

  • Notes

  • PassThru

  • Confirm

  • WhatIf

    Set-ADFSClaimDescription [-TargetName] <string[]> [-ClaimType ] [-IsAccepted ] [-IsOffered ] [-IsRequired ] [-Name ] [-Notes ] [-PassThru] [-Confirm] [-WhatIf] []

  • TargetName

  • ClaimType

  • IsAccepted

  • IsOffered

  • IsRequired

  • Name

  • Notes

  • PassThru

  • Confirm

  • WhatIf

Detailed Description

The Set-ADFSClaimDescription cmdlet sets properties on an existing AD FS claim description.

Parameters

ClaimType

Specifies the claim type URI of the claim.

Default Value: **

Data Type: Uri

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

IsAccepted

Specifies that the claim should be published in federation metadata as a claim that is accepted by the federation service.

Default Value: **

Data Type: Boolean

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

IsOffered

Specifies that the claim should be published in federation metadata as a claim that is offered by the federation service.

Default Value: **

Data Type: Boolean

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

IsRequired

Specifies that the claim should be published in federation metadata as a claim that is required by the federation service.

Default Value: **

Data Type: Boolean

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

Name

Specifies the friendly name of this claim.

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

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

TargetClaimDescription

Specifies the claim description that will be modified by the cmdlet. This value is typically taken from the pipeline.

Default Value: **

Data Type: ClaimDescription

Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

true (ByValue)

pipelineInput

Position?

1

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

TargetClaimType

Specifies the claim type of the claim description that will be modified by the cmdlet.

Default Value: **

Data Type: Uri[]

Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

true

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

true (ByValue)

pipelineInput

Position?

1

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

true

variableLength

TargetName

Specifies the friendly name of the claim description that will be modified by the cmdlet.

Default Value: **

Data Type: string[]

Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

true

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

true (ByValue)

pipelineInput

Position?

1

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

true

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

Microsoft.IdentityServer.PowerShell.Resources.ClaimDescription

A class structure for representing a claim description object for the Federation Service.

Return Type

None

Notes

  • All Set-* cmdlets have a positional parameter (at position 0) with a name that starts with Target*. This parameter defines the search criteria (and the parameter set). For example, Set-ADFSRelyingParty has the parameters TargetName, TargetIdentifierUri, and TargetRelyingParty. You can use only one of these Target* parameters to identify which RelyingParty will be modified. Because these parameters are positional, their name does not have be specified. Therefore, the following commands are identical in effect.
    Changes the RelyingParty object whose name is RP1, setting its name to RP2 Set-ADFSRelyingParty -TargetName RP1Name -Name RP2Name OR Set-ADFSRelyingParty RP1Name -Name RP2Name

Examples

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

Command Prompt: C:\PS>

 
Set-ADFSClaimDescription -TargetName "Role" -Name "New Role Claim Name"

Description

-----------

Sets a new name for the "Role" claim description.

See Also

Reference

Add-ADFSClaimDescription
Get-ADFSClaimDescription
Remove-ADFSClaimDescription

Other Resources

Online version: