⚠️ v1-v3 APIs have been deprecated.
Although these APIs are not shut off yet, all new development with APIs should use the newest version of our API if available, and the version /1 in all other cases. These later versions are based on RESTful principles, secured by OAuth 2.0, and provide JSON messages, search, pagination, sorting, and filtering.

PUT

Set Password by Username Using Cleartext

Resource URL

https://api.onelogin.com/api/v3/users/username/
:username

Parameters

Content-Type required string	Set to `application/xml`.
username required string	Set to the `username` of the user for which you want to set a password.
password required string	Set to the password value using cleartext. Hashes are never stored as cleartext. They are stored securely using cryptographic hash. OneLogin continuously upgrades the strength of the hash. Ensure that the value meets the password strength requirements set for the account.
password_confirmation required string	Ensure that this value matches the `password` value exactly.

Sample Response

200 OK
400 Bad Request
404 Not Found

This request generates no response.

<error>
   <title>Invalid Request</title>
   <message>Validation failed: Password doesn't match confirmation, The two passwords 
      don't match</message>
</error>

<error>
   <title>Record Not Found</title>
   <message>No user found by username 'johannesxie'</message>
</error>

Sample cURL Request

Try it out with a test account first: Start off with using this cURL request with a test OneLogin account and API key. Once you’ve familiarized yourself with the API’s behavior, switch over to using your production OneLogin account and API key. Be sure to replace placeholder values surrounded by { } with actual values.

curl -v -u {api_key}:x -X PUT -H "Content-Type: application/xml" \
-d '<user>
      <password>{password}</password>
      <password_confirmation>{password_confirmation}</password_confirmation>
    </user>' \
https://api.onelogin.com/api/v3/users/username/{username}