User API
The User API manages user accounts that can log in to Deepser. This section describes the endpoints, role-based permissions, and available fields.
Only Administrators with access to the User Module can create, update, and delete users. Operators and Key Users can only retrieve user records. End Users cannot access this resource via the API.
Endpoints
Single user:
http://deepserhost/api/rest/user/[id]
Multiple users:
http://deepserhost/api/rest/users
Roles
| Administrator | Operator | Key User | User | |
|---|---|---|---|---|
| Actions Allowed | RETRIEVE CREATE UPDATE DELETE | RETRIEVE | RETRIEVE |
Fields
The following table lists all fields of the User entity:
| Field | Description |
|---|---|
| user_id | The unique ID of the record. |
| avatar | User avatar icon. If not set, the system assigns one randomly. |
| username | The login username. Must be unique across the system. Manually created users have usernames like admin or name.surname. LDAP-imported users have a prefix with the directory ID and a backslash (e.g., 1\name.surname). |
| role | The user role. Refer to your system configuration for the correct role IDs. |
| firstname | First name. |
| lastname | Last name. |
| Email address for notifications. Required for the email integration to function correctly. | |
| password | Login password. Stored encrypted in the database. LDAP users authenticate directly against the LDAP server, so no password is stored locally. |
| is_active | Whether the user is active. Inactive users cannot log in, do not appear in select boxes, and do not receive email notifications. |
| startup_page | The page displayed after login. Contains a list of available system pages. |
| locale | User language. Deepser supports multiple languages natively. |
| timezone | User timezone for displaying dates. All dates are stored internally in UTC and converted to the user's timezone on display. |
| company_id | The company the user belongs to. Each user can belong to exactly one company. Companies support a 2-level hierarchy (parent and sub-companies), which controls data visibility for corporate structures. |
| is_supervisor | When enabled, the user can see data for their entire company and its sub-companies. For Deepser Backend users (Administrator, Operator, Key User) with company-restricted visibility, this grants access to all company data. For end users, supervisors can see all Service Operations within their company scope instead of only their own. |
| company_visibility | Restricts the user to see only data from their own company and sub-companies. For Deepser Backend users, this limits the data visible across all modules. For end users, this field is ignored because they can only see their own records by default (unless is_supervisor is enabled). |
| formtemplate_id | The form template ID used by the record. |
| modified | Date of the last update. |
| created | Creation date of the record. |
| display_username | The display name shown in the interface (typically first name + last name). |