Edit

Set-ADFSClaimDescription

  • Reference
Module:
ADFS

Sets the properties of an existing claim description.

Syntax

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

Description

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

Examples

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

C:\PS>Set-ADFSClaimDescription -TargetName "Role" -Name "New Role Claim Name"

Description

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

Parameters

-ClaimType

Specifies the claim type URI of the claim.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IsAccepted

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

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IsOffered

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

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IsRequired

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

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the friendly name of this claim.

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

-Notes

Specifies any notes for this claim description.

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

-PassThru

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TargetClaimDescription

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

Type:ClaimDescription
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-TargetClaimType

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

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

-TargetName

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

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.IdentityServer.PowerShell.Resources.ClaimDescription

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

Outputs

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