Description

This function changes a cPanel account's password.

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=change_password&oldpass=luggage12345&newpass=luggage54321&user=example&enablemysql=1&enabledigestauth=1



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Change the password for "example" from "luggage12345" to "luggage54321"
$skroob_luggage = $cpanel->api2(
    'Passwd', 'change_password', 
    array(
        'user' => 'example',
        'oldpass' => 'luggage12345',
        'newpass' => 'luggage54321',
		'enablemysql' => '1',
		'enabledigest' => '1',
    ) 
);



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Change the password for "example" from "luggage12345" to "luggage54321"
my $skroob_luggage = $cpliveapi->api2(
    'Passwd', 'change_password',
    { 
        'user' => 'example',
        'oldpass' => 'luggage12345',
        'newpass' => 'luggage54321',
		'enablemysql' => '1',
		'enabledigest' => '1',
    }
);




cpapi2 --user=username Passwd change_password user=example oldpass=luggage12345 newpass=luggage54321 enablemysql=1 enabledigest=1



{
  "cpanelresult": {
    "apiversion": 2,
    "func": "change_password",
    "data": [
      {
        "passwdoutput": "Password for \u201cexample\u201d has been changed.\nUpdating FTP passwords for example\nFTP password files updated.\nFTP vhost passwords synced\n",
        "status": 1,
        "applist": [
          {
            "app": "system"
          },
          {
            "app": "ftp"
          },
          {
            "app": "mail"
          },
          {
            "app": "postgresql"
          }
        ],
        "statustxt": "Password changed for user \u201cexample\u201d."
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Passwd"
  }
}



Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The account name.

A valid cPanel account username.
username
oldpassstring

Required

The account's current password.

A secure password.luggage12345
newpassstring

Required

The new password.

A secure password.luggage54321
enablemysqlBoolean

Whether to update the account's MySQL password.

This parameter defaults to 0.

  • 1 — Update password.
  • 0 — Do not update password
1
enabledigestBoolean

Whether to enable Digest Authentication on the account.

This parameter defaults to 0.

  • 1 — Enable Digest Authentication.
  • 0 — Do not update Digest Authentication.
1

Returns

ReturnTypeDescriptionPossible valuesExample
passwdoutput
stringThe function's raw output.A result message.
Password for \u201cexample\u201d has been changed.\nUpdating FTP passwords for example\nFTP password files updated.\nFTP vhost passwords synced\n
statustxt
stringThe text of the result message.A result message.
Password changed for user \u201cexample\u201d
applistarray of hashesAn array of hashes that contains the applications for which the system changed passwords.This array of hashes includes the app return.
 

app

string

An application name.

The function returns this value in the applist hash.

A valid application name.
postgresql
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