Set User Password

Last updated
Save as PDF

setUserPassword

Given a user ID, password and optional company ID, this web service updates a user's password on the Services Portal and may require the user to change the password at the next login attempt.

void setUserPassword(String companyId, String userId, String password, boolean forcePwdReset) throws WSException

companyId: (optional) A string of maximum length 10 that specifies the unique company identifier. If no company is specified, the company of the authorized user will be used.
userId: A string of maximum length 10 that identifies the user whose password should be updated.
password: A string that specifies the new password for the user.
The password must adhere to the following guidelines:
    - Must be 8 to 35 characters in length.
    - Must contain at least one alpha and one numeric character.
    - Cannot contain embedded spaces.
forcePwdReset: A Boolean value indicating if the user must change their password at the next login attempt.

Authorization Requirements

The credentials supplied with this method call (as specified in the accompanying WS-Security header) must be authorized to the following application(s) and their associated role-based permissions.

Required Application Licenses
- Remote Integration

Required User Permissions
- Admin role

Customer integrators are authorized to their own company's data only.

Sample XML Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.

<soap:Body>

<setUserPassword>

<companyId>MYCOMPANY</companyId>

<userId>JSMITH</userId>

<password>NewPassword1</password>

<forcePwdReset>1</forcePwdReset>

</setUserPassword>

</soap:Body>

Sample XML Response

<soapenv:Body>

<p431:setUserPasswordResponse xmlns:p431="http://websvcs.omaswebws"/>

</soapenv:Body>

Exceptions

001 Unknown Error.
003 Company not authorized for integration.
004 User not authorized.
005 Invalid company id.
006 Invalid user id.
007 Invalid password.