Disable User

Overview

Hydrolix allows you to disable user accounts when they should no longer have access to the system. Once a user account is disabled, it can't be re-enabled.

To restore access, create a new account for the user.

Disable users through the API

Requires: super_admin role

Endpoint: PATCH /config/v1/users/{id}

To disable a user account, send a PATCH request with the following request body:

{
  "enabled": false
}

Users can't be re-enabled.

A disabled user can't be re-enabled. You must create a new account to grant access again.

Disable users through the UI

The Hydrolix UI provides an option to disable user accounts which uses the same API endpoint described above under the hood.

1. Navigate to the Security tab in the left-hand sidebar.
2. Select the user you want to disable.
3. Uncheck the User Enabled box.
4. Select Save changes.

The user is now disabled.

View disabled users

You can retrieve user account status information using the GET /config/v1/users endpoint.

List disabled usersList enabled usersList all users (enabled and disabled)

GET /config/v1/users?enabled=false

GET /config/v1/users?enabled=true

GET /config/v1/users