Manage users
Create user accounts, assign roles, reset passwords and deactivate leavers on the Tenant Management page.
- Version: 0.4
- Role: superadmin
- Type: task
A CID222 tenant is a user account. Tenant Management is where you create accounts, give them a role, put them into tenant groups, hand out password-reset links and deactivate people who have left.
What do I need?
- Licence
- Any
- Role
superadmin
Prerequisites
- The appliance has completed the first-boot setup wizard and you can sign in.
- You are signed in as the superadmin. An admin_user cannot open this page.
- At least one tenant group exists if you want the new account to inherit shared provider credentials.
Only the superadmin creates, edits, deletes and resets accounts. A viewer can open the page
and read it; every change it attempts is refused with READ_ONLY_ROLE. Every other role is shown
Access denied with the message Only the superadmin can manage users.
Warning
Invite user and the four bulk actions (Invite selected users, Activate selected users, Deactivate selected users, Delete selected users) are not wired to the gateway in 0.4. They show success toasts and change nothing. Use Add user and the per-row actions instead.
/assets/screenshots/tenants@0.4.pngCreate a user
Open the page
Select Administration → Tenant Management.
The list shows every account you may see, with the summary line
{total} tenants · {active} active on this page under the table.
Start a new account
Select Add user.
The Add New User dialog opens.
Name the account
Enter the login name in Username.
The username is the sign-in identifier. It accepts letters, digits, underscores and hyphens only, up to 100 characters; anything else is rejected with Username can only contain letters, numbers, underscores, and hyphens.
Add the optional details
Fill in Contact Email and Description if you use them.
Contact Email must be a valid address of at most 50 characters. Neither field is used for sign-in, and neither is used to send mail.
Choose the role
Open Role and pick one of the five values:
- Superadmin — the appliance owner; the only role that manages accounts and access.
- Admin User — day-to-day security administration for its own department.
- Normal User — an end user of the gateway with no administrative access.
- Viewer (Read-only) — reads every page and is refused every change.
- Auditor — reads compliance and governance evidence, never message content.
The role decides which pages the account is offered. See Access control for the full matrix.
Set the first password
Enter a password in Password and repeat it in Confirm Password.
The password must be at least 8 characters and contain a lowercase letter and a digit. It is stored as a bcrypt hash and is never returned by the API.
Save
Select Save changes.
A Tenant created successfully toast appears and the account is added to the list. The new
account is also enrolled into the default tenant group — All Users unless
DEFAULT_TENANT_GROUP names another — so that it inherits that group's provider credentials
and therefore has models to choose from.
Reset a password
CID222 never mails a password. Resetting produces a one-time link that you deliver yourself.
Open the row menu
Find the account, select Open menu at the end of its row, then select Reset password.
For a directory account the item is disabled and carries the sub-line Managed in your directory.
Copy the link
Wait for Generating link... to finish, then select the copy button beside the link.
The toast Reset link copied to clipboard confirms it. The dialog states when the link
expires: Expires {when}. Generating a new link invalidates any previous one.
Deliver the link out of band
Send the link to the user through a channel you trust.
Anyone holding the link can set that account's password until it expires or is used. If the installation has no mail channel the dialog says so: This installation has no email channel configured, so no reset mail can reach anyone - handing this link over is entirely up to you.
Which channels exist, and whether users can request their own reset, is configured under
Settings — the delivery channel is one of admin_link (nothing is sent),
SMTP, or EmailJS.
Deactivate or delete an account
Deactivating keeps the row that sessions, detections and event logs point at. Deleting removes it.
Deactivate a leaver
Select the row to open Edit User, clear the Active Status checkbox, and select Save changes.
The Status column changes to Inactive and a Tenant updated successfully toast appears. An inactive account no longer counts against a licensed seat cap.
Delete an account only when you must
Select Open menu → Delete, type the account's username into Enter username to confirm deletion., and select Delete.
The confirmation restates the role being removed and warns Please be careful, this operation can not be rolled back. A Tenant deleted successfully toast confirms it.
Change group membership
Open the membership dialog
Select Open menu → Manage groups.
Manage Groups lists every tenant group with a switch and its member count.
Toggle the groups
Switch a group on to add this account to it, off to remove it.
Each change is applied immediately and confirmed with Member added to group successfully or Member removed from group successfully. Group security-filter overrides apply to every tenant in the group.
Fields reference
Add New User / Edit User
| Field | Required | Rule | What it does |
|---|---|---|---|
| Username | Yes | Letters, digits, _, -; max 100 characters; unique | The sign-in name and the name shown everywhere in the product |
| Contact Email | No | Valid address, max 50 characters | Contact detail only. Not a login, and no mail is sent to it |
| Description | No | Max 255 characters | Free note shown in the Description column |
| Role | Yes | One of the five roles | Decides which pages and endpoints the account reaches |
| Active Status | No | Default on | An inactive account cannot sign in and frees a licensed seat |
| Password | Yes on create | Min 8 characters, one lowercase, one digit | Stored as a bcrypt hash. Left blank on edit, the current password is kept |
| Confirm Password | With password | Must match | Guards against a typo in the initial password |
List columns
| Column | Shows |
|---|---|
| Username | The sign-in name |
| Contact Email | The contact address, or an em dash |
| Description | The free note, or an em dash |
| Status | Active or Inactive |
| Role | Superadmin, Admin User, Normal User, Viewer (Read-only) or Auditor |
| Groups | Up to two group tags, then a +N overflow tag |
| Created | The date the account was created |
The toolbar filters — the Filter tenants… box, Status and Role — are applied by the gateway, not in the browser, so the totals under the table count the filtered set and paging walks it.
Verify
- The new account appears in the list with the role and status you set.
- Open Event logs and filter for the account. Creating it writes a
RESOURCE_CREATEDrow, editing it writesRESOURCE_UPDATED, and deleting it writesRESOURCE_DELETED. Each row names the fields that changed, so a role change is distinguishable from a re-saved form. - Generating a reset link writes a
PASSWORD_RESET_LINK_ISSUEDrow; the user opening it and setting a password writesPASSWORD_RESET_COMPLETED. - Sign in as the new account. The sidebar shows only the pages its role may open.
If it fails
- Tenant with this name already exists — the username is taken. Usernames are unique across the appliance, including deactivated accounts.
- Failed to create tenant with a 403 and the code
LIMIT_EXCEEDED— the licence covers fewer active accounts than you are trying to reach. The message names the cap and the count in use. Deactivate an account you no longer need, or raise the limit on your licence. The refusal is also recorded as aLICENSE_LIMIT_EXCEEDEDevent whether or not the request was made from the dashboard. - This account is managed by your directory (AD/LDAP). Its password must be reset in the directory - a link issued here would set a password that sign-in never checks. — you asked for a reset link on a directory-backed account. Reset it in Active Directory instead.
- Failed to generate reset link — the gateway refused the request. Check that you are signed in as the superadmin and that the account still exists.
- Only the superadmin can manage users. — your role can open the page but cannot use it.
- This is a read-only demo account (viewer role) — actions and changes are disabled. — the
request was refused with
READ_ONLY_ROLE. Sign in with an account that is not a viewer.
Next steps
- Tenant groups — group accounts so one set of credentials and one policy override reaches a whole department.
- Access control — decide which pages each role is offered.
- Credentials — give the new account a provider key, directly or through its group.
Last updated on