COMMAND EVERYTHING.

Set-AdfsClaimDescription

Modifies the properties of a claim description.

Active Directory · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft ADFS reference: Modifies the properties of a claim description. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.

Set-AdfsClaimDescription [-IsAccepted <Boolean>] [-IsOffered <Boolean>] [-IsRequired <Boolean>]
 [-Notes <String>] [-Name <String>] [-ClaimType <String>] [-ShortName <String>] [-TargetName] <String>
 [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Set-AdfsClaimDescription. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.

Supported environments

Windows / ADFS · Windows Server 2025 documentation; feature/module prerequisites apply

Parameters

-ClaimType: Specifies the claim type URI of the claim.
-Confirm: Prompts you for confirmation before running the cmdlet.
-IsAccepted: Indicates whether the claim is published in federation metadata as a claim that is accepted by the Federation Service.
-IsOffered: Indicates whether the claim is published in federation metadata as a claim that is offered by the Federation Service.
-IsRequired: Indicates whether the claim is published in federation metadata as a claim that is required by the Federation Service.
-Name: Specifies the friendly name of the claim to modify.
-Notes: Specifies text that describes the purpose of the claim description. The cmdlet adds the notes to the claim description.
-PassThru: Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
-ShortName: Specifies the unique short name identifier for the claim description that is used for issuing and consuming JWT tokens.
-TargetClaimDescription (required): Specifies a ClaimDescription object. The cmdlet modifies the ClaimDescription object that you specify. To obtain a claim description, use the Get-AdfsClaimDescription cmdlet.
-TargetClaimType (required): Specifies the claim type of the claim description to modify.
-TargetName (required): Specifies the friendly name of the claim description to modify.
-TargetShortName (required): Specifies the short name identifier that AD FS uses to lookup an existing claim description.
-WhatIf: Shows what would happen if the cmdlet runs. The cmdlet is not run.

Prerequisites

Windows with the ADFS module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.

Security considerations

This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.

Examples

Example 1: Change the name of a claim description

Set-AdfsClaimDescription -TargetName "Role" -Name "RoleDesc"

This command changes the name of the claim description named Role to RoleDesc. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.

Sources

https://github.com/MicrosoftDocs/windows-powershell-docs/blob/b7645dd8c687139b28e845119da30ec670526507/docset/winserver2025-ps/ADFS/Set-AdfsClaimDescription.md

https://learn.microsoft.com/powershell/module/adfs/set-adfsclaimdescription?view=windowsserver2025-ps

Personal collections

Explain or customize this command with AI

Related commands

Get-ADComputer

Get-ADGroup

Get-ADGroupMember

Get-ADPrincipalGroupMembership