Page tree
Skip to end of metadata
Go to start of metadata

You can change a user's password with the updateUserPassword method.

Permissions to run the request: Account OwnerAdministratorsDepartment Administrators.

Department Administrators can change passwords of users belonging only to the department they manage and its daughter departments.


Parameters

ParameterTypeDescription
credentials (required)credentialsRead the description of the Credentials object.
userId (required)stringID of the user whose password you want to change.
password (required)stringThe new password.


Return Value

After the request has been completed, the system returns an object with the following properties:

ParameterTypeDescription
successbool'True' if the password has been changed.

Possible Errors

Unknown userA user with the specified ID was not found.
Permission DeniedYou have no permissions to change the password of the specified user.
Wrong ParametersThe 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="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>string</userId>
      <password>password</password>
    </UpdateUserPasswordRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

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>
  • No labels