Child pages
  • WHM API 1 Functions - twofactorauth_get_issuer
Skip to end of metadata
Go to start of metadata

 

Description

This function returns the currently configured issuer. The issuer appears within the authentication app.

Examples 


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


Notes:

  • 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)
{  
   "data":{  
      "system_wide_issuer":"example.cpanel.net",
      "issuer":"example.cpanel.net"
   },
   "metadata":{  
      "version":1,
      "reason":"OK",
      "result":"1",
      "command":"twofactorauth_get_issuer"
   }
}
 Output (XML)
<result>
    <data>
        <system_wide_issuer>example.cpanel.net</system_wide_issuer>
        <issuer>example.cpanel.net</issuer>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>twofactorauth_get_issuer</command>
    </metadata>
</result>


Note:

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

Parameters

This function does not accept parameters.

Returns

Return

TypeDescriptionPossible valuesExample

issuer

string

The issuer's name for the currently-authenticated user.

A valid string.example.cpanel.net
system_wide_issuerstring

The system's default issuer's name.

A valid string.

Note:

If the root user has not configured a system-wide issuer, this value defaults to the system hostname.

example.cpanel.net