Add-Adfs Claim Description

Module:
adfs
Adds a claim description to the Federation Service.

Syntax 

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

Description

The Add-AdfsClaimDescription cmdlet adds a claim description to the Federation Service.

Examples

Example 1: Add a claim description 

PS C:\> Add-AdfsClaimDescription -Name "Role" -ClaimType "https://Fabrikam.com/role"

This command adds the claim description named Role for a custom claim that has the specified claim type.

Required Parameters

-ClaimType

Specifies the claim type URN or URI of the claim. All claim descriptions must include a valid URN or URI.

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

Specifies a friendly name for the claim description to add.

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

Optional Parameters

-Confirm

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

Indicates whether the claim is published in federation metadata as a claim that the Federation Service accepts.

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

Indicates whether the claim is published in federation metadata as a claim that the Federation Service offers.

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

Indicates whether the claim is published in federation metadata as a claim that the Federation Service requires.

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

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

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

Specifies a short name.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
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
Accept pipeline input: False
Accept wildcard characters: False

Notes

  • Use claim descriptions to configure the list of claims that are available to be offered or accepted by Active Directory Federation Services (AD FS) 2.0.