Description

This function manages Digest Authentication on a cPanel account.

 Windows Vista®, Windows® 7, and Windows® 8 require that you enable Digest Authentication support in order to access your Web Disk over a clear text, unencrypted connection. If the server has an SSL certificate signed by a recognized certificate authority and you are able to make an SSL connection over port 2078, you do not need to enable this.

Examples 


https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Passwd&cpanel_jsonapi_func=set_digest_auth&enabledigest=1&password=luggage12345&user=example

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Enable digest authentication on the "example" account
$digest_auth = $cpanel->api2(
    'Passwd', 'set_digest_auth', 
    array(
        'user' => 'example',
        'password' => 'luggage12345',
        'enabledigest' => '1',
    ) 
);

 

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Enable digest authentication on the "example" account
my $digest_auth = $cpliveapi->api2(
    'Passwd', 'set_digest_auth',
    { 
        'user' => 'example',
        'password' => 'luggage12345',
        'enabledigest' => '1',
    }
);

 

 
cpapi2 --user=username Passwd set_digest_auth user=example password=luggage12345 enabledigest=1

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "set_digest_auth",
    "data": [
      {
        "reason": "Digest Authentication enabled.",
        "result": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Passwd"
  }
}

   

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The account name.

A valid cPanel account username.

 

username
passwordstring

Required

The account's current password.

A secure passwordluggage12345
enabledigestBoolean

Required

Whether to enable Digest Authentication on the account.

  • 1 — Enable Digest Authentication.
  • 0 — Disable Digest Authentication.
1

Returns

ReturnTypeDescriptionPossible valuesExample
reasonstring

A reason for failure.

This function only returns a reason value if it failed.

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1