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

 

Description

This function displays the Two-Factor Authentication (2FA) policy status on the server.

Examples 


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


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":{  
      "is_enabled":"1"
   },
   "metadata":{  
      "version":1,
      "reason":"OK",
      "result":"1",
      "command":"twofactorauth_policy_status"
   }
}
 Output (XML)
<result>
    <data>
        <is_enabled>1</is_enabled>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>twofactorauth_policy_status</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

is_enabled

Boolean

Whether the 2FA security policy is enabled.

 

  • 1 — Enabled.
  • 0Not enabled.
1