Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
WHM API 1 Functions - twofactorauth_set_issuer - Developer Documentation - cPanel Documentation
Child pages
  • WHM API 1 Functions - twofactorauth_set_issuer
Skip to end of metadata
Go to start of metadata

 

Description

This function sets the issuer value that the system uses to generate the secret and otpurls values for Two-Factor Authentication on your accounts.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/twofactorauth_set_issuer?api.version=1&issuer=hostname.example.com
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/twofactorauth_set_issuer?api.version=1&issuer=hostname.example.com
 Command Line
whmapi1 twofactorauth_set_issuer issuer=hostname.example.com


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{  
   "metadata":{  
      "version":1,
      "reason":"OK",
      "result":"1",
      "command":"twofactorauth_set_issuer"
   }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>twofactorauth_set_issuer</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
issuerstring

Required

The issuer's name.

A valid string.
hostname.example.com

Returns

This function returns only metadata.