UAPI Functions - TwoFactorAuth::set_user_configuration - Knowledgebase

Description

This function configures the two-factor authentication settings for an account.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/TwoFactorAuth/set_user_configuration?secret=JBSWY3DPEHPK3PXP&tfa_token=528112

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Set TwoFactorAuth user configuration.
$sa_settings = $cpanel->uapi(
    'TwoFactorAuth', 'set_user_configuration',
    array(
        'secret'     => 'JBSWY3DPEHPK3PXP',
        'tfa_token   => '528112',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Set TwoFactorAuth user configuration.
my $sa_settings = $cpliveapi->uapi(
    'TwoFactorAuth', 'set_user_configuration',
    {
        'secret'     => 'JBSWY3DPEHPK3PXP',
        'tfa_token   => '528112',
    }
);

cPanel Template Toolkit

[% SET sa_settings = execute('TwoFactorAuth', 'set_user_configuration'

{

secret => 'JBSWY3DPEHPK3PXP',

tfa_token => '528112'

}

); %]

Command Line

uapi --user=username TwoFactorAuth set_user_configuration secret=JBSWY3DPEHPK3PXP tfa_token=528112

Notes:

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

 Output (JSON)

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

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
secret	string	Required The 16-character string that UAPI'sTwoFactorAuth::generate_user_configuration function generates.	A valid 16-character string.	JBSWY3DPEHPK3PXP
tfa_token	integer	Required The six-digit security code that the time-based one-time password (TOTP) authentication app generates.	A six-digit integer.	528112

Parameter

Type

Description

Possible values

Example

secret

string

Required

The 16-character string that UAPI'sTwoFactorAuth::generate_user_configuration function generates.

A valid 16-character string.

JBSWY3DPEHPK3PXP

tfa_token

integer

Required

The six-digit security code that the time-based one-time password (TOTP) authentication app generates.

A six-digit integer.

528112

Returns

Return	Type	Description	Possible values	Example
tfa_configured	Boolean	Whether two-factor authentication is enabled.	1 — Enabled. 0 — Disabled.	1

Return

Type

Description

Possible values

Example

tfa_configured

Boolean

Whether two-factor authentication is enabled.

1 — Enabled.
0 — Disabled.

Knowledgebase

Categories

Categories