Edit

Share via

Set-AdfsAdditionalAuthenticationRule

  • Reference
Module:
ADFS

Sets the global rules that provide the trigger for additional authentication providers to be invoked.

Syntax

Set-AdfsAdditionalAuthenticationRule
   [-AdditionalAuthenticationRules] <String>
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AdfsAdditionalAuthenticationRule
   [-AdditionalAuthenticationRulesFile] <String>
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AdfsAdditionalAuthenticationRule cmdlet sets the global rules that provide the trigger for additional authentication providers to be invoked. When the claims engine evaluates the additional authentication rules and determines the requirement for multiple factor authentication, the user is prompted to perform additional authentication. You may specify rules in the form of claim rules strings, or designate a file that contains claim rules.

Use this rule only when all your applications are capable of performing web based credential collection through Active Directory Federation Services (AD FS). Applications that use protocols like WS-Trust will fail to obtain a security token if the trigger is true as a result of evaluation of the rules.

You can also set rules on the individual relying party trust using the Set-AdfsRelyingPartyTrust cmdlet with the AdditionalAuthenticationRule parameter.

Examples

Example 1: Set a global additional authentication rule

PS C:\> Set-AdfsAdditionalAuthenticationRule -AdditionalAuthenticationRules 'c:[type == "http://schemas.microsoft.com/ws/2012/01/insidecorporatenetwork", value == "false"] => issue(type = "http://schemas.microsoft.com/ws/2008/06/identity/claims/authenticationmethod", value = "http://schemas.microsoft.com/claims/multipleauthn" );'

This command sets an additional authentication rule to require multiple-factor authentication.

Parameters

-AdditionalAuthenticationRules

Specifies rules for additional authentication. For more information about the claims language for rules, see Understanding Claim Rule Language in AD FS 2.0 & Higher on TechNet.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-AdditionalAuthenticationRulesFile

Specifies the fully qualified file path of a text file that contains claim rules.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
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
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False