See api-docs Menu
  1. Home >
  2. API >
  3. v1-v3 >
  4. Users >
  5. Set Password by ID Using Cleartext

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.

Set Password by ID Using Cleartext

Resource URL

Before calling this API, consider using its version /1 equivalent.

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

Parameters

Content-Type

required

string

 Set to application/xml.

id

required

string

Set to the user’s ID with .xml appended. For example, 123456.xml. If you don’t know the user’s id, use the Get Users API call to return all users and their id values.

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

  • 201 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 id '11111'</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/{user_id}.xml

Postman Collection

Run In Postman

    Clicking Run in Postman button navigates to the page where you can fork the collection to your workspace. Forking the collection into your workspace will enable you to contribute to the source collection using pull requests. You can also view the collection in a public workspace if you like and even import a copy of the collection using the links present on the screen.

Have a Question?

Found a problem or a bug? Submit a support ticket.

Looking for walkthroughs or how-to guides on OneLogin's user and admin features? Check out the documentation in our Knowledge Base.

Have a product idea or request? Share it with us in our Ideas Portal.