Page tree
Skip to end of metadata
Go to start of metadata

 

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

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.

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

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.

# Get TwoFactorAuth user configuration.
my $sa_settings = $cpliveapi->uapi(
    'TwoFactorAuth', 'get_user_configuration',
    }
);

Note:

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

 

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

Note:

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

 

 Command Line
uapi --user=username TwoFactorAuth get_user_configuration

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. 
  • We introduced this functionality in cPanel & WHM version 56.

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

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

Note:

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

   

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