AVAILABLE WITH BUSINESS SUBSCRIPTION
Method: updateUserPassword
Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, or custom roles.
Department Administrators and users with a custom role can change passwords of the users belonging to the departments they manage and their sub-departments.
Parameters
Parameter | Type | Description |
---|
token (required) | string | Access token. You can obtain a token by making a request. |
userId (required) | string | The ID of the user whose password you want to change. |
password (required) | string | The new password. |
Return Value
After the request has been completed, the system returns an object with the following properties:
Parameter | Type | Description |
---|
success | bool | 'True' if the password has been changed. |
Possible Errors
Type | Description |
---|
Unknown user | A user with the specified ID was not found. |
Permission Denied | You have no permissions to change the password of the specified user. |
Wrong Parameters | The system failed to process the request because the 'password' value is not specified or invalid. |
Sample Call
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
xmlns="https://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<UpdateUserPasswordRequest>
<credentials>
<token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
</credentials>
<userId>string</userId>
<password>password</password>
</UpdateUserPasswordRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML
Sample Response
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
xmlns="https://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<UpdateUserPasswordResult>
<success>true</success>
</UpdateUserPasswordResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML