Software Development Kit

cPanel & WHM's API [+] cPanel & WHM's API [-]


Modules and Plugins [+] Modules and Plugins [-]


cPanel & WHM Hooks [+] cPanel & WHM Hooks [-]


cPAddons (Site Software) [+] cPAddons (Site Software) [-]


System Administration [+] System Administration [-]


Developer Software [+] Developer Software [-]


Back to All Documentation



integrationblogcta.jpg

PasswdStrength Module Documentation

This module provides access to cPanel's password scoring system.

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.

PasswdStrength::get_password_strength

API Version: 2 - Click here for documentation
Description: Retrieve the strength of a specified password. This API call is only available in cPanel & WHM 11.32.
Parameters:  
  password (string)
  The password to test.
Returns:  
 
<data>
  <strength> An integer between 0 and 100 that indicates the strength of the specified password.</strength>
</data>

PasswdStrength::get_required_strength

API Version: 2 - Click here for documentation
Description: Return the required password strength for a specific application.
Parameters:  
  app (string)
  The application corresponding to the password strength you would like to retrieve. Accepted values include 'htaccess', 'passwd', 'ftp', 'createacct', 'bandmin', 'cpaddons', 'pop', 'sshkey', 'postgres', 'webdisk', and 'mysql'.
Returns:  
 
<data>
  <strength> A string value that contains a number that denotes the required password strength for the requested application. (e.g. A value of '1' through '100')</strength>
</data>

PasswdStrength::appstrengths

API Version: 2 - Click here for documentation
Description: Return password strength settings set in WHM's 'Main >> Security Center >> Password Strength Configuration' section. If this requirement is in place, this function will return all password strength requirements on a per-application basis.
Returns:  
 
<data>
  <strength> An integer value that represents the strength requirement for that service.</strength>
  <app> A string value that contains the name of the service to which the password strength applies.</app>
</data>

Topic revision: r2 - 26 Mar 2012 - 16:23:35 - Main.JenniferDoubrava