See api-docs Menu

v1-v3 APIs have been deprecated

Don't worry, these APIs are deprecated, but they aren't shut off yet.

All new development with APIs should use the newest version of our API: /1. API /1 is based on RESTful principles, is secured by OAuth 2.0, and provides JSON messages, search, pagination, sorting, and filtering.

Set Password by ID Using Cleartext

Resource URL

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

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

Try it out with a test account first: Start off with using this Postman Collection 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.

Replace sample variables indicated by { } in the sample request body with your actual values. Also, be sure to set Postman-specific environment variables indicated by {{ }}.

Download for the Users API


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.