# Offboarding/Locking users

# Offbarding users Admin only

Offboarding users in easyroam will lead to the following actions:

The user will no longer be able to log in
All of the user's profiles will be revoked

To offboard a user, use the following endpoint:

DELETE /api/user/{userID}

With {userID} being the ID of the user to offboard.

On success the response will be true. On failure the response will be the default API error response.

# Reactivating users Admin only

Depending on your organization's workflow or offboarding practices, you may want to reactivate a user after they have been offboarded. This can be done by using the following endpoint:

PUT /api/user/{userID}/undelete

With {userID} being the ID of the user to reactivate.

On success the response will be true. On failure the response will be the default API error response.

Note

Reactivating a user will not restore their profiles. Changes to profiles are permanent and cannot be undone.

# Locking users Admin only

Locking users in easyroam will lead to the following actions:

The user will no longer be able to generate new profiles
The user will still be able to log in
The user can still manage their existing profiles

To lock a user, use the following endpoint:

PUT /api/user/{userID}/status

With {userID} being the ID of the user to lock.

The body of the request must be a JSON object with the following format:

{
  "locked": true
}

This will lock the user. To unlock the user, set locked to false.

On success the response will be true. On failure the response will be the default API error response.