NetLock RMMNetLock RMM Docs
II — Console Reference

Users & Roles

Creating console users, roles as reusable permission sets, per-user permissions, scoping access to tenants, and managing two-factor authentication.

Users & Roles

The Users page at /users is where console user accounts are created, edited, and deleted. User accounts are the identities that sign in to the console, usually one account per technician.

Each account has a permission set and a tenant scope. The permission set is the matrix of flags described in 14.4. An account either follows a role (a named, reusable permission set managed under Users › Roles) or carries custom permissions of its own. The role defines what an account may do. The tenant scope (14.5) defines where, and it is always set on the account.

Users list page with a handful of user rows

14.1 The Users list

The Users list shows one row per user account.

ColumnMeaning
UsernameThe account's login identifier.
RoleThe role the account follows. An account with its own permission set shows a Custom chip; its tooltip names the role it was detached from, if any.
TenantsThe tenant access of the account: All for an account with access to all tenants, including tenants created later (14.5), otherwise the number of assigned tenants.
Mail AddressThe account's email, for notifications and password-reset delivery.
PhoneOptional contact number.
Last LoginTimestamp of the user's most recent successful login.
IP AddressSource IP of the most recent login.
2FAActivated or Deactivated.

Toolbar actions include Add (14.2), Roles (opens the roles page, 14.4, shown to accounts that hold roles_enabled) and Export data to JSON, CSV or HTML. The actions column of a row opens the user's settings page (14.3).

Double-clicking a row, or using the Manage action, opens the user's settings page. The list can be narrowed to the members of one role or to the custom accounts: the member count on the roles page opens the list with a filter chip. The close icon on the chip removes the filter.

14.2 Creating a user

Add User opens the Add User dialog.

Add User dialog with Name field, auto-generated password, Role dropdown, and Auth Mode selector

Fields:

  • Name: required. This is the username the user will log in with.
  • Password: auto-generated, 12 characters, read-only in the dialog. The Copy to Clipboard button copies the username and the password together, for example into your password manager.
  • Role: required, without a preselection. The list holds every role of the instance (14.4) and Custom (set permissions later). With a role the new account starts with that role's permissions and follows it; with Custom it starts without permissions. It can sign in but sees nothing until its permissions are set on the settings page.
  • Auth Mode: Password, SSO, or Password & SSO. Chooses how the user signs in.
    • Password: local password only.
    • SSO: single sign-on only; the local password is not used.
    • Password & SSO: either method works.
  • Access to all tenants: a switch. When it is on, the account has access to every tenant, including tenants created later, without a tenant list (14.5). The dialog pre-selects it when the chosen role can manage user accounts (users_enabled, users_manage and users_edit together, which the Administrator role always holds); a hint under the switch says so, and it can be switched off. For every other role and for Custom it is off, and the new account starts without tenants: assign them on its settings page. An account with users_edit can change the permissions and tenants of every account, including its own. Give it to administrators only.

Submitting the dialog creates the account. The password is stored hashed, never in plain text, and the new account is flagged for mandatory password change on first login. When the user first signs in, the console forces them to pick a new password before anything else.

Tip: Keep the dialog open until you have captured the generated password. Once the dialog closes, there is no way to retrieve that initial password from the UI. If you miss it, use the Reset Password flow (14.6) to generate a new one.

14.3 The user settings page

User Settings at /user_settings is the full editor for a single user. It is reached from the Users list via double-click or the Manage button.

User Settings page with permission matrix visible

The page is divided into sections:

  • Account details: username, email, phone, authentication mode and the enabled switch.
  • Tenant scope: the Access to all tenants switch and the table described in 14.5, at the top of the permissions tab.
  • Role: the card described in 14.4 under Roles on the account page.
  • Permissions: the matrix described in 14.4.
  • 2FA: the switches described in 14.6.
  • Actions: the Reset Password and Delete buttons described in 14.6 and 14.8.

A Save button at the top or bottom of the page commits every edit on the page in one step; unsaved changes are kept in the browser until you save or navigate away.

14.4 Roles and permissions

A role is a named permission set stored on the instance. The roles page at /users/roles (reached through the Roles button of the Users list) lists every role with its description, its type, the number of accounts that follow it, its author and when it was last changed.

The built-in Administrator role

One role is built in: Administrator. It always holds every permission the console knows, including permissions added by a later update, and it cannot be renamed, edited or deleted. It can be duplicated and exported like any other role. After an update from a version before 3.3.0.5, accounts that held every permission follow Administrator, and all other accounts keep their permissions as custom permissions.

Creating roles

Add opens the Add Role dialog: a name (unique on the instance), a description and a Start from template that pre-fills the matrix. A role created from a template is an ordinary role that you can change freely:

TemplateContents
EmptyNo permissions.
AdministratorEvery permission, for "everything except ..." roles.
TechnicianDevices, scripts, patching, remote tools and tickets in full; no user, role or instance settings, no tenant creation, no secrets.
HelpdeskView devices, remote control and remote shell, restart, wake, sync, App Hub, tickets; no policies, scripts or deletions.
Read-onlyEvery page in view mode; no changes, no remote tools, no secrets.
ReportingDashboards, reports, events and audit in view mode.

Duplicate on a role opens the same dialog with Copy of <role> selected; the new role is then opened for fine-tuning.

Editing a role

The role page at /users/roles/{id} holds the name, the description, the number of accounts that follow the role (with a link to that list) and the permission matrix. A saved change applies to every account that follows the role at that account's next page load. Nobody has to sign out. The built-in role is shown read-only.

Export and import

Export writes the role as a JSON file (role_<name>_<timestamp>.json) with a format marker, the name, the description and the permission object. Import on the roles page reads such a file back as a new role: the dialog previews the name, the number of granted permissions and any keys it does not know (they are ignored), and proposes <name> (imported) when the name is taken. A permission template file (a plain permission object without a name) is imported the same way; the dialog asks for the name.

Deleting a role

A role is deleted from its row or from its page after a confirmation. The built-in role cannot be deleted, and neither can a role that accounts still follow. Reassign those accounts first (the member count links to them).

Roles on the account page

The permissions tab of User Settings carries a Role card between the tenant table and the matrix:

  • The Role select holds every role and Custom. While the account follows a role, the matrix shows that role's values read-only; picking another role previews its values the same way. The binding is written when the page is saved.
  • Customize permissions (shown while the account follows a role) detaches the account in the page: the matrix keeps the role's values and becomes editable, and the save writes them as the account's own permissions. The list then shows the account as Custom, with the previous role in the tooltip.
  • Save as new role (shown for a custom account, needs roles_add) stores the current matrix as a new role and, by default, binds the account to it right away.
  • Reset to role (shown for a custom account that was detached from a role) puts that role back into the select.

Custom permissions are never changed by a role. A change to a role reaches only the accounts that follow it.

The last account that can manage users

At least one account must be able to manage users: the last enabled account that holds users_enabled, users_manage and users_edit cannot be disabled, deleted, bound to a role without those three permissions, or saved without them. The page shows the reason next to the affected controls, and the save refuses the change with the same message. Apart from this rule, you can edit your own account like any other.

The switch-plus-checkbox pattern

The permission matrix is a set of sections, each introduced by a parent switch. The parent switch turns the whole section on or off. Inside each section, child checkboxes control the individual functions of the section. When the parent switch is off, its child checkboxes are disabled. Their values are kept and take effect again when the parent switch is turned back on.

The pattern is the same in every section, so you can turn off access to a page without losing the child settings you made for it.

The sections

The top-level sections in the matrix, in the order they appear:

  • Devices: access to the Devices list, and per-tab / per-tool child checkboxes covering General, Software, Task Manager, Antivirus, Events, Updates, Remote Shell, Remote File Browser, Remote Control, Remote EventLog Viewer, Remote Registry Editor, SNMP Tools, Shutdown, Reboot, Wake On LAN, Force Sync, Deauthorize, and Move.
  • Tenants: create / manage / edit / delete for tenants, plus analogous children for Locations and Groups.
  • Automations: add / edit / delete for automation rules. See Chapter 5.
  • Policies: add / manage / edit / delete for policies. See Chapter 6.
  • Patch Management: access to the /patch-management page. See Chapter 7.
  • Collections: a section per sub-feature: Antivirus Controlled Folder Access, Application Control, Device Control, Sensors, Scripts, Jobs, Custom Fields, App Hub, Software Deployment, and File Server. Each has its own child checkboxes for add / edit / manage / delete as applicable. See Chapter 8.
  • Relay Server: access to the Relay Server page and the manage / add / edit / delete children.
  • Website Uptime Monitoring: page access.
  • Port Scanner: page access.
  • Events: page access.
  • Audit: page access.
  • Users: the Users list plus add / manage / edit / delete children, and the Roles block with the roles page switch plus add / edit / delete children.
  • Reports: page access plus Create, Edit, Delete, Generate, Schedules, and Brand Templates children.
  • Tickets: optional module; add / edit / delete / assign plus the manage-section children (departments, templates, SLAs, and so on).
  • AI: AI Chat page access. See Chapter 13.
  • Settings: sub-sections for every settings page. Notifications have per-channel children (Mail, Microsoft Teams, Telegram, ntfy.sh, Webhook, App) with add / test / edit / delete; Overview, Licensing, Maintenance, Updates, Database, Retention, API tokens, Remote Screen, IP Whitelist (the IP whitelist and country restriction tabs of the Security page), Rate limiting, SSO, Sessions, Whitelabeling, Globalization, Custom Fields, Dashboards, Reports, and AI/LLM all have their own section flags.

Every checkbox in the matrix corresponds to exactly one permission flag in the product. The flag names are the strings used throughout this documentation, for example devices_remote_shell, policies_edit, collections_scripts_add and reports_generate. See Appendix X.2 for the complete list.

How to approach the matrix

A practical pattern: start from the template that comes closest (Read-only for an observer, Technician for a hands-on operator), save it as a role, and adjust the children the role needs. Accounts that share a job then follow that role; an account that needs one exception is detached with Customize permissions, or gets a role of its own saved from its matrix.

14.5 Tenant scoping

At the top of the permissions tab sit the Access to all tenants switch and, below it, the Tenants table. The table lists every tenant of the instance with one checkbox per row. Ticking a tenant grants this user access to the devices, policies, events, and everything else scoped under that tenant.

Tenant scope table with checkboxes selecting two of three tenants

Columns on the Tenants table: Name, Description, Author, Date, and Company.

Access to all tenants. With the switch on, the account has access to every tenant, including tenants created later, and the table shows every row ticked and not editable. The console and the server evaluate the switch at request time, so a tenant somebody else creates is visible to the account at once.

With the switch off, the ticked tenants are the scope. A user with tenants A and B ticked sees the devices, events, policies, jobs and other items of A and B. Everything in tenant C is hidden from that user, whatever page access (such as devices_authorized_enabled) their permission matrix grants.

The account stores both the switch and the list of tenant identifiers. While the switch is on, the list keeps the tenants of the last save and is ignored. When you switch it off, the list is editable and defines the scope again. Changes to the switch and to the tenant list are written to the audit log together with the permission changes of the save.

Accounts created before version 3.3.0.11 have the switch off. Turn it on, on the settings page, for every account that should have access to all tenants. Setting the switch needs users_add or users_edit, the same as ticking tenants.

A tenant created in the console or through the public API is added to the tenant list of the account that created it. The list of an account with the switch on is not changed.

Permissions and tenant scope apply together. To see devices in tenant A, a user needs the devices_authorized_enabled flag (permission to open the Devices page) and access to tenant A, through the switch or a tick in the scope table (permission to see anything in that tenant).

14.6 Two-factor authentication and password reset

2FA switches

Two switches under the 2FA section of User Settings:

  • Two Factor Enabled: turns 2FA on for this user. With this switch on, the user is prompted for a second factor on every login.
  • Two Factor Remote Actions: a second, narrower switch that requires 2FA specifically for sensitive remote operations (remote shell, remote file browser, remote control, remote registry editor, and similar). Available only while Two Factor Enabled is on.

When Two Factor Enabled is first toggled on, the user is walked through 2FA enrolment on their next login.

Reset Password

A Reset Password button under the Actions section generates a one-time password for the user. The dialog shows the new password in a read-only field, with a Copy to Clipboard button for handoff, and sets the account back into mandatory-password-change state so the user must pick a fresh password on their next login.

Use this when a user has lost their credentials, or after the initial Add User dialog's generated password was not captured. If no account with users_edit can sign in on a self-hosted deployment, see Recover access to the Web Console.

Warning: The one-time password is visible on screen only once. After you close the dialog, it cannot be retrieved. Run Reset Password again if you need a new one.

14.7 What the Users page does not do

The Users page has no impersonation and no password policy settings.

  • No impersonation. To test what another user sees, sign in as that user (with a password you reset for that purpose) or use a dedicated test account with the permissions you want to check.
  • No password policy configuration. Passwords generated on account creation and on reset always have 12 characters. Minimum length, complexity rules, rotation interval and password history cannot be configured.

14.8 Deleting a user

The Delete button on User Settings opens the Delete User confirmation dialog. Deletion is:

  • Hard: the account is removed, not disabled, and cannot be restored.
  • Cascading to AI Chat: the user's AI Chat conversations and their messages are also deleted.
  • Audited: an audit entry delete on entity type user is written, including the deleted user's identifier and the admin who performed the deletion. See Chapter 12.3.

After deletion the console redirects back to the Users list.

Events, sessions, logins, and actions previously performed by the deleted user remain in the Audit log.

14.9 Dialogs

DialogPurpose
Add UserCreate a new user account with an auto-generated password and its role.
Add RoleCreate a role from a template, as a copy of a role, or from the matrix of an account.
Import RoleCreate a role from an exported role file or an older permission template file.
Reset PasswordGenerate a one-time password for an existing user.
Delete UserConfirm hard deletion of a user account.
Export DataExport the Users list or the roles list to JSON, CSV or HTML.

Permissions

FlagGates
users_enabledOpening the Users page.
users_addThe Add User dialog.
users_manageOpening a user's settings page.
users_editSaving changes on a user's settings page, including its role.
users_deleteDeleting a user.
roles_enabledOpening the roles page and the Roles button of the Users list.
roles_addCreating, duplicating and importing roles, and Save as new role on an account.
roles_editSaving a role; the change applies to every account that follows it.
roles_deleteDeleting a role without members.

Access to the 2FA switches and the Reset Password button is gated by users_edit, like other changes to the account.

14.10 Roles in the public API

The public API (see Appendix X.9) uses the same model:

  • An account's role is an object with id, name and builtIn, or null for custom permissions, next to roleOrigin. From version 3.3.0.5, role is an object or null; before, it was a lower-case string.
  • GET /v1/roles lists the roles.
  • POST /v1/users accepts roleId. It needs the users:permissions:write scope because it grants permissions.
  • PUT /v1/users/{id}/role binds or detaches an account.
  • PUT /v1/users/{id}/permissions detaches a bound account.
  • The tenant access of an account is allTenants and tenants on the same endpoints, see X.9.7.

See Appendix X.2 for the full permission catalogue, including the flags referenced in the matrix throughout 14.4.