Set-AdfsClaimDescription

Set-AdfsClaimDescription is accessible with the help of adfs module. To install adfs on your system please refer to this adfs.

Synopsis

Modifies the properties of a claim description.

Description

The Set-AdfsClaimDescription cmdlet modifies properties on a Active Directory Federation Services (AD FS) claim description.

Parameters

-ClaimType
Specifies the claim type URI of the claim.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-IsAccepted <Boolean]>
    Indicates whether the claim is published in federation metadata as a claim that is accepted by the Federation Service.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-IsOffered <Boolean]>
    Indicates whether the claim is published in federation metadata as a claim that is offered by the Federation Service.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-IsRequired <Boolean]>
    Indicates whether the claim is published in federation metadata as a claim that is required by the Federation Service.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Name <String>
    Specifies the friendly name of the claim to modify.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Notes <String>
    Specifies text that describes the purpose of the claim description. The cmdlet adds the notes to the claim description.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-PassThru <SwitchParameter>
    Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-ShortName <String>
    Specifies the unique short name identifier for the claim description that is used for issuing and consuming JWT tokens.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-TargetClaimDescription <ClaimDescription>
    Specifies a ClaimDescription object. The cmdlet modifies the ClaimDescription object that you specify. To obtain a claim description, use the Get-AdfsClaimDescription cmdlet.

    Required?                    true
    Position?                    1
    Default value                none
    Accept pipeline input?       true (ByValue)
    Accept wildcard characters?  false

-TargetClaimType <String>
    Specifies the claim type of the claim description to modify.

    Required?                    true
    Position?                    1
    Default value                none
    Accept pipeline input?       true (ByValue)
    Accept wildcard characters?  false

-TargetName <String>
    Specifies the friendly name of the claim description to modify.

    Required?                    true
    Position?                    1
    Default value                none
    Accept pipeline input?       true (ByValue)
    Accept wildcard characters?  false

-TargetShortName <String>
    Specifies the short name identifier that AD FS uses to lookup an existing claim description.

    Required?                    true
    Position?                    1
    Default value                none
    Accept pipeline input?       true(ByValue)
    Accept wildcard characters?  false

-Confirm <SwitchParameter>
    Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

    Required?                    false
    Position?                    named
    Default value                false
    Accept pipeline input?       false
    Accept wildcard characters?  false

-WhatIf <SwitchParameter>
    Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.

    Required?                    false
    Position?                    named
    Default value                false
    Accept pipeline input?       false
    Accept wildcard characters?  false

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>]

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

—————–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.

You can check the Version, CommandType and Source of this cmdlet by giving below command.

Get-Command Set-AdfsClaimDescription

You can also read about

To know more PowerShell cmdlets(Commands) on Active Directory Federation Services(ADFS) click here

Click on this Link for an Single place where you get all the PowerShell cmdlet sorted based on the modules.

You can also refer other blogs on PowerShell at link

You can also refer other blogs on Microsoft at link

And also if you required any technology you want to learn, let us know below we will publish them in our site http://tossolution.com/

Like our page in Facebook and follow us for New technical information.

References are taken from Microsoft