1. Home >
2. API >
3. 2 >
4. Users >
5. Unlock User

Unlock User

Use this API to unlock a locked user in OneLogin.

The API will check if the specified user is locked, call for an unlock, and return a JSON response with the successful or unsuccessful completion of the unlock.

Resource URL

https://<subdomain>/api/2/users/<user_id>/unlock

Sample Response

{
    "messsage": "User unlocked"
}

{
    "message": "unknown attribute: user_id",
    "name": "BadRequestError",
    "statusCode": 400
}

{
    "message": "Unauthorized",
    "name": "UnauthorizedError",
    "statusCode": 401
}

{
    "message": "Validation failed: Username must be unique within {subdomain}",
    "name": "UnprocessableEntityError",
    "statusCode": 422
}

{
    "message": "User cannot be unlocked"
}

Postman Collection

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 {{ }}.

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.

Sample Code

cURL

Replace sample values indicated by < > with your actual values.

curl 'https://<subdomain>/api/2/users/<12345>/unlock' \
-X POST \
-H "Authorization: bearer <access_token>" \
-H "Content-Type: application/json" \

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.