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

Description

This function checks whether Digest Authentication is enabled for a cPanel user. Windows® Vista, Windows® 7, and Windows® 8 require Digest Authentication support in order to access Web Disk over an unencrypted connection.

Examples 


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


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


Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The cPanel account username.

A valid cPanel username on the server.

user

Returns

ReturnTypeDescriptionPossible valuesExample
digestauthBooleanWhether Digest Authentication support is enabled.
  • 1 — Enabled.
  • 0 — Disabled.
1