Software Development Kit
cPanel & WHM's API [+] cPanel & WHM's API [-]Modules and Plugins [+] Modules and Plugins [-]
cPanel Modules
Writing cPanel Modules PHP Accounting Module cPanel::Accounting Perl Module Writing cPanel Plugins
Writing cPanel Plugins PHP in cPanel Plugin Interfaces cPanel CGI Scripts Live PHP in cPanel Plugins Plugin Variables Installing cPanel Plugins Adding Icons and Groups Plugin Installation File Generator Plugin Security Policy (
.pdf)
WHM Plugins
Creating WHM Plugins ACL Reference Table The swapip Utility cPanel Logger Module Pluggable dnsadmin Modules EasyApache Modules
Custom Modules?
cPanel & WHM Hooks [+] cPanel & WHM Hooks [-]
Standardized Hooks Introduction Taxonomy Getting Started Hooks Management Interface Hookable Events Advanced Usage Troubleshooting
Legacy Hooks Introduction Writing Function Hooks Script Hooks Custom Event Handlers cPanel Logger Module Universal Password Trap Hooking into EasyApache
EasyApache Hooks?
cPAddons (Site Software) [+] cPAddons (Site Software) [-]
System Administration [+] System Administration [-]
Developer Software [+] Developer Software [-]
Back to All Documentation
Passwd Module Documentation
The Passwd module allows users to change their cPanel account's password. The functions within this module may or may not be governed by a feature list. The required feature list may vary from function to function, to review a total list of the available features sets on a cPanel server, please see "Feature Manager" in WHM.Passwd::change_password
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Change a cPanel account's password. |
| Parameters: | |
| newpass (string) | |
| The new password for the cPanel account. | |
| oldpass (string) | |
| The current password for the cPanel account. | |
| user (string) | |
| The username of the cPanel account whose password you wish to change. | |
| Returns: | |
<data> <passwdoutput> A string that contains a success message or reason for failure.</passwdoutput> <status> A boolean value indicating success or failure. '1' if successful. '0' if failed.</status> <applist> <app> A string value that contains any applications whose passwords have changed (ftp, system, etc).</app> </applist> <statustxt> A string value that contains a success message or reason for failure. This value will be sent to the interface.</statustxt> </data> |
Passwd::set_digest_auth
For cPanel & WHM 11.34| API Version: | 2- Click here for documentation |
|---|---|
| Description: | Enables or disables Digest Authentication for an account. Windows Vista®, Windows® 7, and Windows® 8 require Digest Authentication support to be enabled in order to access your Web Disk over a clear text, unencrypted connection. If the server has a 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. |
| Parameters: | |
| password (string) | |
| The current password for your account. | |
| enabledigest (boolean) | |
| A boolean value indicating if Digest Authentication should be enabled or disabled for the Web Disk user. A value of '1' indicates that Digest Authentication should be enabled. A value of '0' indicates that Digest Authentication should be disabled. | |
| user (string) | |
| The username of the cPanel account whose password you wish to change. | |
| Returns: | |
<data> <result>A boolean value indicating if the call succeeded in setting Digest Authentication for the Web Disk user. A value of '1' indicates that the call was successful. A value of '0' indicates that the call failed.</result> <reason>A string value containing a successful status message if the call succeed or the reason the call failed. </reason> </data> |
Topic revision: r4 - 10 May 2013 - 17:53:32 - Main.StacyWyatt