Child pages
  • UAPI Functions - TwoFactorAuth::set_user_configuration
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

 

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


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 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',
    )
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 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',
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Template Toolkit
<!-- Set TwoFactorAuth user configuration. -->
[% SET sa_settings = execute('TwoFactorAuth', 'set_user_configuration' 
   { 
      secret => 'JBSWY3DPEHPK3PXP', 
      tfa_token => '528112' 
   } 
); %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 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.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
    "messages": null,
    "errors": null,
    "status": 1,
    "metadata": {},
    "data": {
        "tfa_configured": 1
    }
}


Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
secretstring

Required

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

A valid 16-character string.
JBSWY3DPEHPK3PXP
tfa_tokeninteger

Required

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

A six-digit integer.
528112

Returns

ReturnTypeDescriptionPossible valuesExample
tfa_configuredBooleanWhether two-factor authentication is enabled.
  • 1 — Enabled.
  • 0 — Disabled.

1

 

 

 

  • No labels