Description

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

Examples 


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

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

// Get TwoFactorAuth user configuration.
$sa_settings = $cpanel->uapi(
    'TwoFactorAuth', 'get_user_configuration'
);

 

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

 

<!-- Get TwoFactorAuth user configuration. -->
[% execute('TwoFactorAuth', 'get_user_configuration') %]

 

uapi --user=username TwoFactorAuth get_user_configuration

{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":{  
      "is_enabled":1,
      "issuer": "Example cPanel Inc"
   }
}

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
is_enabledBooleanWhether two-factor authentication is enabled for the account.
  • 1 — Enabled.
  • 0 — Disabled.

1

issuerstringThe name of the issuer of the authentication code.A valid string.Example cPanel Inc