Set-Adfs
Claim
Description
Syntax
Set-AdfsClaimDescription
[-IsAccepted <Boolean>]
[-IsOffered <Boolean>]
[-IsRequired <Boolean>]
[-Notes <String>]
[-Name <String>]
[-ClaimType <String>]
[-ShortName <String>]
[-TargetName] <String>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AdfsClaimDescription
[-IsAccepted <Boolean>]
[-IsOffered <Boolean>]
[-IsRequired <Boolean>]
[-Notes <String>]
[-Name <String>]
[-ClaimType <String>]
[-ShortName <String>]
[-TargetShortName] <String>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AdfsClaimDescription
[-IsAccepted <Boolean>]
[-IsOffered <Boolean>]
[-IsRequired <Boolean>]
[-Notes <String>]
[-Name <String>]
[-ClaimType <String>]
[-ShortName <String>]
[-TargetClaimType] <String>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AdfsClaimDescription
[-IsAccepted <Boolean>]
[-IsOffered <Boolean>]
[-IsRequired <Boolean>]
[-Notes <String>]
[-Name <String>]
[-ClaimType <String>]
[-ShortName <String>]
[-TargetClaimDescription] <ClaimDescription>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AdfsClaimDescription cmdlet modifies properties on a Active Directory Federation Services (AD FS) claim description.
Examples
Example 1: Change the name of a claim description
PS C:\> Set-AdfsClaimDescription -TargetName "Role" -Name "RoleDesc"
This command changes the name of the claim description named Role to RoleDesc.
Required Parameters
Specifies a ClaimDescription object. The cmdlet modifies the ClaimDescription object that you specify. To obtain a claim description, use the Get-AdfsClaimDescription cmdlet.
Type: | ClaimDescription |
Position: | 0 |
Default value: | None |
Accept pipeline input: | True (ByValue) |
Accept wildcard characters: | False |
Specifies the claim type of the claim description to modify.
Type: | String |
Position: | 0 |
Default value: | None |
Accept pipeline input: | True (ByValue) |
Accept wildcard characters: | False |
Specifies the friendly name of the claim description to modify.
Type: | String |
Position: | 0 |
Default value: | None |
Accept pipeline input: | True (ByValue) |
Accept wildcard characters: | False |
Specifies the short name identifier that AD FS uses to lookup an existing claim description.
Type: | String |
Position: | 0 |
Default value: | None |
Accept pipeline input: | True (ByValue) |
Accept wildcard characters: | False |
Optional Parameters
Specifies the claim type URI of the claim.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Indicates whether the claim is published in federation metadata as a claim that is accepted by the Federation Service.
Type: | Boolean |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Indicates whether the claim is published in federation metadata as a claim that is offered by the Federation Service.
Type: | Boolean |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Indicates whether the claim is published in federation metadata as a claim that is required by the Federation Service.
Type: | Boolean |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the friendly name of the claim to modify.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies text that describes the purpose of the claim description. The cmdlet adds the notes to the claim description.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the unique short name identifier for the claim description that is used for issuing and consuming JWT tokens.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | 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 to modify. Because these parameters are positional, you do not have to specify their name. Therefore, the following commands are identical in effect. The commands change the RelyingParty object named RP1 to RP2.
-
Set-ADFSRelyingParty -TargetName RP1Name -Name RP2Name
-
Set-ADFSRelyingParty RP1Name -Name RP2Name