Reset-RASMFAUsers

NAME

Reset-RASMFAUsers

SYNOPSIS

Reset MFA TOTP/EmailOTP authentication for all or specific users.

SYNTAX

Reset-RASMFAUsers -AllUsers <SwitchParameter> [-MFAId <uint>] [-SiteId <uint>] [-Type {GAuthTOTP | TOTP | MicrosoftTOTP | EmailOTP}] [<CommonParameters>]

Reset-RASMFAUsers -Users <string[]> [-MFAId <uint>] [-SiteId <uint>] [-Type {GAuthTOTP | TOTP | MicrosoftTOTP | EmailOTP}] [<CommonParameters>]

DESCRIPTION

Reset MFA TOTP/EmailOTP authentication for all or specific users.

PARAMETERS

-Users <string[]> List of users for which to reset Google Authentication.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID where the users need to be reset.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AllUsers <SwitchParameter> When present, TOTP users will be reset.

        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MFAId <uint> The ID of the MFA Provider to be modified.

In case of TOTP Provider, the ID will always be 0. Default: 0.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Type <MFAUsersType> The MFA Provider Type to be modified.

If the parameter is omitted, the site ID of the Licensing Server will be used.

Possible values: GAuthTOTP, TOTP, MicrosoftTOTP, EmailOTP

        Required?                    false

        Position?                    named

        Default value                TOTP

        Accept pipeline input?       false

        Accept wildcard characters?  false

<CommonParameters>

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ----------

Reset-RASMFAUsers -Users "user1@domain.com", "user2@domain.com" -Type TOTP

Reset MFA TOTP authentication for user1 and user2 on current site. ---------- EXAMPLE 2 ----------

Reset-RASMFAUsers -Users "user1@domain.com", "user2@domain.com" -Type EmailOTP -MFAId 1

Reset MFA EmailOTP authentication for user1 and user2 in MFA with Id 1. ---------- EXAMPLE 3 ----------

Reset-RASMFAUsers -Users "user1@domain.com", "user2@domain.com" -SiteID 2 -Type TOTP

Reset MFA TOTP authentication for user1 and user2 on site '2'. ---------- EXAMPLE 4 ----------

Reset-RASMFAUsers -AllUsers -Type TOTP

Reset MFA TOTP authentication for all users on current site ---------- EXAMPLE 5 ----------

Reset-RASMFAUsers -AllUsers -Type EmailOTP -MFAId 1

Reset MFA EmailOTP authentication for all users in MFA with Id 1. ---------- EXAMPLE 6 ----------

Reset-RASMFAUsers -AllUsers -SiteID 2 -Type TOTP

Reset MFA TOTP authentication for all users on site '2'.

Last updated

© 2024 Parallels International GmbH. All rights reserved.