UAPI Functions - TwoFactorAuth::get_user_configuration - Knowledgebase

Knowledgebase

Description

This function retrieves the user's configuration settings for two-factor authentication.

Examples

cPanel or Webmail Session URL

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

LiveAPI PHP Class

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

// Get TwoFactorAuth user configuration.

$sa_settings = $cpanel->uapi(

'TwoFactorAuth', 'get_user_configuration'

);

LiveAPI Perl Module

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

# Get TwoFactorAuth user configuration.

my $sa_settings = $cpliveapi->uapi(

'TwoFactorAuth', 'get_user_configuration',

}

);

cPanel Template Toolkit

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

Command Line

uapi --user=username TwoFactorAuth get_user_configuration

Notes:

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

 Output (JSON)

{ 
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{ 
 
   },
   "data":{ 
      "is_enabled":1,
      "issuer": "Example cPanel Inc"
   }
}

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
is_enabled	Boolean	Whether two-factor authentication is enabled for the account.	1 — Enabled. 0 — Disabled.	1
issuer	string	The name of the issuer of the authentication code.	A valid string.	Example cPanel Inc

Knowledgebase

Categories

Categories