Enable-DSUser2FA

Synopsis

Enable a predefined 2FA authentication for a user.

Syntax

__AllParameterSets

Enable-DSUser2FA -UserID <guid> -TwoFactorAuthenticationType <TwoFactorAuthenticationType>
 [-AsLegacyResponse] [<CommonParameters>]

Description

Enable a predefined 2FA authentication for a user. The server must be configured to allow 2FA enforcement on an individual basis.

Examples

PS C:\> Enable-DSUser2FA -UserID $userId -TwoFactorAuthenticationType GoogleAuthenticator

Set an Authenticator (TOTP) for the user identified by $userId. The user will complete the set up on the next login.

Parameters

-AsLegacyResponse

In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-TwoFactorAuthenticationType

2FA type

Type: Devolutions.RemoteDesktopManager.TwoFactorAuthenticationType
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-UserID

User's ID

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

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

Notes

For more information, type "Get-Help Enable-DSUser2FA -detailed". For technical information, type "Get-Help Enable-DSUser2FA -full".