Remove 2FA settings

This function removes the Two-Factor Authentication (2FA) settings for one or more specified user accounts.

Note:

If you remove the 2FA settings for an account, the user must perform the setup procedure again to re-configure 2FA on the account.

Authorizations:
query Parameters
user
required
string

The account's username.

Note:

To remove multiple users, increment the parameter name. For example, user-1, user-2, or user-3.

Examples:
Multiple users.
user=user-1=username1 user-2=username2 user-3=username3
A single user.
user=example.com

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  twofactorauth_remove_user_config \
  user='example.com'

Response samples

Content type
application/json
{
  • "data": {
    • "failed": {
      • "property1": "You are not authorized to modify example",
      • "property2": "You are not authorized to modify example"
      },
    • "users_modified": [
      • "example"
      ]
    },
  • "metadata": {
    • "command": "twofactorauth_remove_user_config",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}