You can change a user's password with the updateUserPassword method.
Permission to run the request: Account Owner, Administrator, Organization Administrator.
Parameters
Parameter | Type | Description |
---|
credentials (required) | credentials | Read the description of the Credentials object. |
userId (required) | string | ID of the user whose password you want to change. |
password (required) | string | 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
Unknown user | A user with the specified ID was not found. |
PermissionDenied | 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. |
A new password should include from 6 to 100 characters with one uppercase letter (A-Z) and a number (0-9).
Sample Call
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<UpdateUserPasswordRequest>
<credentials>
<accountUrl>http://myaccount.ispringlearn.com</accountUrl>
<email>email@email.com</email>
<password>password</password>
</credentials>
<userId>1</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="http://schemas.xmlsoap.org/soap/envelope/"
xmlns="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<UpdateUserPasswordResult>
<success>true</success>
</UpdateUserPasswordResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML