Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Add-AdfsClaimDescription

Last Updated: 3/8/2017

SYNOPSIS

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.

PARAMETERS

-ClaimType

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

Type: String
Parameter Sets: (All)
Aliases: 

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
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
Parameter Sets: (All)
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: 

Required: True
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
Parameter Sets: (All)
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: 

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

-ShortName

Specifies a short name.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

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.

Get-AdfsClaimDescription

Remove-AdfsClaimDescription

Set-AdfsClaimDescription

© 2017 Microsoft