Documentation Center

change_password

Change Password.

Description

The user's password is changed to the new value

Parameters

action
change_password
password
New password. The password cannot be set to blank.
user
Name of the user to change. Use the current user, if the name is blank.

Example URL

http://<host>:<port>/<context>/web/user.xql?action=change_password&password=<value>&user=<value>

Successful Result

This function returns a standard API result element (<result status='SUCCESS' statusCode='0' message='Localized Message' messageKey='message.key'/>). A statusCode of 0 indicates a successful execution. Any other statusCode indicates a failure.

Failed Result

Accessing this API feature requires the "Manage application" permission, and the function will throw a permission exception if the permission is not available. It is an error if the password is blank or if it is "guest" user.