Skip to content

User Management

gitsync edited this page Oct 4, 2026 · 5 revisions

Users are managed in Settings → Users.

Settings — Users

Roles

Role Access
admin Full access to all features including destructive operations
standard Configurable access via 11 individual permission flags
read-only Can view all data but cannot create, modify, or delete anything
smb-only SMB authentication only; cannot log into the portal web UI

Standard role permissions

When creating or editing a standard user, toggle each permission individually:

Permission Grants
Terminal Web terminal access
Review sudoers View the Sudoers Hardening diff
Browse files File Browser on datasets and shares
Manage pools & datasets Create/edit/delete pools and datasets
Manage SMB / NFS / iSCSI Manage the respective share type
Manage protection Snapshots, schedules, replication, encryption keys
Manage snapshots Create/restore/clone/delete snapshots
Edit settings Portal settings, alerts, certificates
Manage InterLink Configure InterLink peers
View virtualization See VMs & Containers pages

The Users table shows a capability badge summarizing each standard user's enabled permissions.

Creating a user

Click + Add User:

Field Description
Username Login name (also the OS username for SMB)
Password Portal login password
Role admin, standard, read-only, or smb-only
SMB Home Folder Creates a personal SMB home directory
Allow SSH login Gives the user a Linux account with a shell and this password, so they can log in over SSH (off by default)
Permissions (standard role) individual flags

On creation the portal saves the account to config/users.json, creates the OS user (marked ZNAS portal user), adds it to sambashare, and sets the SMB password.

SSH login and sudo

  • Allow SSH login gives the user a Linux shell with the same password as the portal. Turning it off later locks the account and removes the shell; SMB access and the portal login are untouched.
  • An admin with SSH login is also added to the sudo group, so sudo works and asks for their own password (never passwordless). Demoting the user or turning SSH off removes it again.
  • Your existing Linux accounts are safe. If a Linux account with the same name already exists and ZNAS did not create it (for example your own login), ZNAS never changes its password, shell or sudo rights, and deleting the portal user only removes its SMB access. The portal shows a warning instead and suggests another user name. System accounts (such as root) and the portal's own service account are always off-limits.
  • If the name matches an existing Linux account, the portal asks you to confirm before reusing it for SMB.

Editing / deleting

The ⋮ menu per user offers Edit (email, role, password, SSH login, permissions, 2FA, home folder) and Delete (removes the portal account and Samba access, and the Linux account only if ZNAS created it). Password changes update the portal and Samba passwords, and the Linux password when SSH login is on.

Sessions

Active Sessions lists all logged-in users with creation time. Click ✕ to invalidate a session immediately — the user is redirected to login on their next request.

API keys

API keys give read-only bearer-token access to integration endpoints (e.g. the Homepage widget).

  1. Settings → API Keys → + Generate Key, give it a name
  2. The full key is shown once — copy it immediately (stored hashed)
  3. Use it with Authorization: Bearer <key>
  4. Revoke anytime from the list

Two-Factor Authentication (TOTP)

Any account can enable TOTP from its profile — see Security.

Security notes

  • Passwords hashed with bcrypt; session cookies HttpOnly + Secure
  • All login attempts (success and failure) are audit-logged with client IP
  • Failed logins are rate-limited per IP

Clone this wiki locally