Authentication
Two-Factor Authentication
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.
This function reports an account in the data.users_modified array even if that account had no 2FA settings configured to begin with. Check whether 2FA was actually configured beforehand (for example, with the twofactorauth_get_tfa_config_for_user function) if your integration needs to distinguish an actual removal from a no-op.
get/twofactorauth_remove_user_config
Query parameters
userstring required
The account's username.
Note:
To remove multiple users, increment the parameter name. For example, user-1, user-2, or user-3.
Response
HTTP Request was successful.
Example response
{
"data": {
"users_modified": [
"example"
]
},
"metadata": {
"command": "twofactorauth_remove_user_config",
"reason": "OK",
"result": 1,
"version": 1
}
}