The setPassword Web API Method

Modify a current user password.

Version: 1.3

Required Permissions: Full

HTTP method: POST

Supported by Editions: All

Request Parameters:

Parameter

 Type

Required

Description

password

String

Yes

Current password.

newPassword

String

Yes

New password.

confirmNewPassword

String

Yes

Confirmation of new password.

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

Response Type: setPassword

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

Example

Usage Example

Request

POST /ZendServer/Api/setPassword
password=12345&newPassword=1234&confirmNewPassword=1234

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse >
	<requestData>
		<apiKeyName><![CDATA[Admin]]></apiKeyName>
		<method>setPassword</method>
	</requestData>
	<responseData>
		<userInfo>
			<name>admin</name>
		</userInfo>
	</responseData>
</zendServerAPIResponse>