WebAPI Reference Guide > Available API Methods > Administration Methods > The userSetPassword Method

The userSetPassword Method

Modify a specific user password. This action changes any user password and is an administrative action. Note that a separate action exists for the user to modify his own password and has a lower permission level.

Version: 1.3

Required Permissions: Full

HTTP method: POST

Supported by Editions: All

Request Parameters:

Parameter	Type	Required	Description
username	string	Yes	This username will have his password modified.
password	string	Yes	Password of the user executing this command.
newPassword	string	Yes	New password.
confirmNewPassword	string	Yes	Confirmation of new password.

Expected Response Code: 200 OK. For more information see Response Format.

Response Format: userSetPassword

Possible Action Specific Error Codes: This action has no specific error codes

Example

	Request GET /ZendServer/Api/userSetPassword Response <?xml version="1.0" encoding="UTF-8"?> <zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3"> <requestData> <apiKeyName><![CDATA[Admin]]></apiKeyName> <method>userSetPassword</method> </requestData> <responseData> <userInfo> <name>admin</name> </userInfo> </responseData> </zendServerAPIResponse>

	Related Links: Available API Methods