UAPI Functions - TwoFactorAuth::remove_user_configuration - Knowledgebase

Knowledgebase

Description

This function removes removes the user from the two-factor authentication userdata file.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/TwoFactorAuth/remove_user_configuration

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Remove TwoFactorAuth user configuration.

$sa_settings = $cpanel->uapi(

'TwoFactorAuth', 'remove_user_configuration'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Remove TwoFactorAuth user configuration.

my $sa_settings = $cpliveapi->uapi(

'TwoFactorAuth', 'remove_user_configuration',

}

);

cPanel Template Toolkit

[% execute('TwoFactorAuth', 'remove_user_configuration') %]

Command Line

uapi --user=username TwoFactorAuth remove_user_configuration

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{ 
   "messages":null,
   "errors":null,
   "status":1,
   "data":{ 
      "tfa_removed" : 1
   },
   "metadata":{}
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
tfa_removed	Boolean	Whether the system removed the user from the two-factor authentication userdata file.	1 — Removed. Note: If a removal fails, the system sends a failure response with the reason in the metadata.	1

Return

Type

Description

Possible values

Example

tfa_removed

Boolean

Whether the system removed the user from the two-factor authentication userdata file.

1 — Removed.

Note:

If a removal fails, the system sends a failure response with the reason in the metadata.

Knowledgebase

Categories

Categories