UAPI Functions - TwoFactorAuth::generate_user_configuration - Knowledgebase

Knowledgebase

Description

This function generates an authentication code to enable configuration of two-factor authentication.

Examples

cPanel or Webmail Session URL

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

LiveAPI PHP Class

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

// Generate TwoFactorAuth user configuration.

$sa_settings = $cpanel->uapi(

'TwoFactorAuth', 'generate_user_configuration'

);

LiveAPI Perl Module

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

# Generate TwoFactorAuth user configuration.

my $sa_settings = $cpliveapi->uapi(

'TwoFactorAuth', 'generate_user_configuration',

}

);

cPanel Template Toolkit

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

Command Line

uapi --user=username TwoFactorAuth generate_user_configuration

Notes:

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

Output (JSON)

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
otpauth_str	string	A one-time authentication URL to encode as the QR code.	A valid otpauth URL.
secret	string	A generated code for use with two-factor authentication.	A valid security code.	S3I4WUY7MTHRMMWN

Knowledgebase

Categories

Categories