Roles & Permissions
ServiceRadar uses role-based access control (RBAC) to decide what each signed-in user can see and do. Every user is assigned a role, and every role grants a set of permissions drawn from a fixed permission catalog. Administrators can also create custom role profiles for individual users or reusable user groups. Effective permissions combine one base profile with the profiles from all current group memberships.
This page is for operators and administrators who manage who can do what. For how users sign in (local passwords, OIDC, SAML), see Authentication. For mapping identity-provider groups onto these roles and profiles, see Group Permission Mapping.
The four built-in roles
ServiceRadar ships with four built-in roles. Each is progressively more
privileged: admin can do everything operator can, operator can do
everything helpdesk can, and so on.
| Role | Intended for | What it can do |
|---|---|---|
viewer | Read-only stakeholders | View dashboards, devices, services, observability data (logs, metrics, traces, events, NetFlow, alerts), rules, the playbook catalog, Ansible operation history, and northbound action history. Export device inventory and view its own CLI sessions. Cannot change anything. |
helpdesk | First-line responders | Everything a viewer can do, plus acknowledge and resolve alerts. |
operator | Day-to-day operations staff | Everything helpdesk can do, plus create and update devices, services, observability rules, sweep groups, integrations, SNMP/Sysmon profiles, and NetFlow settings. Run sweeps, discovery, services, reviewed Ansible playbooks, and northbound actions. View settings pages and the audit/security event stream. Operators generally cannot perform destructive auth/security actions or manage RBAC. |
admin | Platform administrators | Full access. Everything operator can do, plus manage users, roles, and auth settings; manage RBAC role profiles; manage credentials, outbound mail, camera recording and archive storage, plugins, edge packages, jobs, remote-access targets and host keys; approve plugin packages and northbound providers; open and review remote-access sessions; and manage audit/security state. |
Permissions below are the building blocks for built-in roles and custom role profiles. The effective base and group-profile rules are described below.
The permission catalog
Internally, access is enforced through a canonical permission catalog. Permissions are grouped by functional area, and each permission declares its default roles -- the built-in roles that receive it out of the box.
The catalog covers these areas:
| Area | Examples of what it controls |
|---|---|
| Analytics | Viewing analytics dashboards; managing saved queries. |
| Devices | Viewing, creating, updating, bulk-editing, importing/exporting, and deleting devices; watching live camera video; viewing recorded camera footage and placing or releasing recording holds; opening device consoles; all SSH/RDP/app/TCP remote-access actions, recordings, and file transfers. |
| Services | Viewing, creating, updating, deleting, and running service checks. |
| Observability | Viewing logs, metrics, traces, events, NetFlow, and alerts; creating/updating/deleting observability rules; acknowledging and resolving alerts. |
| Settings | Viewing settings; managing users and auth; changing own local password; managing personal API credentials and MCP access; managing RBAC; managing networks, NetFlow, integrations, credentials, outbound mail (settings.mail.manage), camera recording and archive storage (settings.recording.*), SNMP/Sysmon profiles, visibility profiles, jobs, plugins, edge packages, remote-access host keys and targets; viewing and managing the audit/security state. See Outbound Mail and Camera Recording & NVR. |
| Plugins | Viewing, staging, approving, and assigning plugin packages. |
| Ansible | Viewing/managing AWX controllers and playbook repositories; viewing canonical operation history; launching reviewed playbooks; authorizing operation cancellation. Reserved schedule keys expose no workflow. |
| Northbound Actions | Viewing, managing, launching, and cancelling provider-neutral northbound actions; managing event handlers. |
| Network Ops | Triggering on-demand sweeps and discovery jobs. |
| CLI Sessions | Approving CLI device authorizations; viewing and revoking your own (or any) CLI sessions; managing CLI auth policy. |
| Dashboards | Publishing, enabling, and disabling dashboard packages via the API. |
| Field survey | Opening ingest streams and uploading room artifacts for owned sessions. |
As a rule of thumb:
- View permissions default to all four roles.
- Create/update/run permissions default to
operatorandadmin. - Acknowledge/resolve alerts defaults to
helpdesk,operator, andadmin. - Destructive, security-sensitive, and administrative permissions
(user management, RBAC, credentials, plugin approval, remote access, audit
state, CLI policy) default to
adminonly.
SRQL and detail-page access
SRQL queries require the effective view permission for the requested data domain, including queries loaded by detail pages, pagination, related data, and previews. Signing in or opening a direct detail URL does not grant access to a domain omitted from the user's effective permissions. Related data can require a different permission from the main record.
Gateway details require devices.view for both live registry information and
stored records. Users without it are redirected to the dashboard with a
permission error.
Live camera video
Watching a camera needs devices.cameras.view in addition to the inventory
access devices.view gives. It covers opening a camera relay, the WebRTC and
websocket video streams, and the camera previews on the Cameras page, the
dashboard, device pages, and the topology map. Opening a relay makes an agent
pull the camera's stream, so the check runs in core as well as in the web UI
and API. Every built-in role has it. To let a role see the camera inventory
without live video, use a custom role profile that omits it. When this
permission was introduced, custom profiles that already granted devices.view
were given it, so upgrading did not change who can watch cameras.
The entity-to-permission mapping and scope authorization contract are owned by
ServiceRadarWebNG.SRQL.EntityAccess in
elixir/web-ng/lib/serviceradar_web_ng/srql/entity_access.ex.
Camera recording, holds, and storage settings
Recorded camera playback, evidence holds on /cameras/:camera_source_id/recordings,
and operator administration under Settings -> System -> Camera Recording ->
Recording & Storage (/settings/recording) use dedicated permissions separate
from live video (devices.cameras.view). All five camera recording permissions
default to admin and can be delegated individually through custom role
profiles (see Camera Recording & NVR):
| Permission | Grants | Default roles |
|---|---|---|
devices.cameras.recordings.view | Open /cameras/:camera_source_id/recordings (Timeline and Published modes), inspect recording metadata and timeline coverage, issue HLS VOD playlists, and stream verified recorded footage (auto, local, or archive). Requires devices.view as well. | admin |
devices.cameras.recordings.hold | Place and release investigation or export holds on recorded camera footage from the camera Timeline, and authorize Accept Archive Loss on /settings/recording?tab=health when an entry is covered by an active hold. | admin |
settings.recording.view | Open /settings/recording and inspect NVR installation and recovery-gate status, per-member desired and applied storage budgets (NVRStorageSettings), immutable archive destination generations, redacted credential names, per-camera block locations and hold-pin status, recording policies, local and object retention projections, and health summaries. | admin |
settings.recording.manage | Register immutable operator:<name> archive destination generations, choose the active destination, toggle archive_enabled, configure per-camera CameraRecordingPolicy assignments (?tab=policy), edit deployment local and object retention settings (?tab=retention), and configure per-member NVRStorageSettings local byte budgets and reserves (?tab=recorders). | admin |
settings.recording.operate | Start supervised recorder operations (bounded camera captures, block archive uploads, destination connectivity tests, and local or archive retrieval checks) and execute audited Health tab dispositions (?tab=health: quarantined block export/preserve intent, confirmed operator_quarantine delete intent, missing archive copy re-archive, and missing archive copy loss acceptance). | admin |
Recording metadata and footage
Opening a camera's Recordings page, listing historical camera recordings,
inspecting timeline coverage or metadata, requesting a timeline or archive
playlist, or reading recorded footage requires both
devices.cameras.recordings.view and devices.view. Live-video permission
(devices.cameras.view) does not grant it. Each inventory, coverage, playlist,
or fragment request reloads the user's persisted active account and current
permissions, so cached authority does not preserve revoked access, and fragment
responses repeat authorization before releasing bytes. Recording-read access
does not grant hold placement, export, or /settings/recording access.
Recording holds
Placing or releasing an investigation or export hold on recorded camera footage
requires devices.cameras.recordings.hold together with devices.view,
devices.cameras.recordings.view, and fresh camera scope. Holds keep at least
one verified copy of every covered block until explicitly released: when a
verified archive copy exists, the hold pins the archive copy so the local copy
remains evictable under the local byte budget and maximum local age; in
local-only mode, before archive verification completes, after archive expiry or
reaping, or if a held archive copy is found missing while the local copy
remains, the hold pins the local copy. Accepting the loss of a missing archive
copy on /settings/recording?tab=health when a hold covers the entry also
requires devices.cameras.recordings.hold. Holds are placed and released on the
camera Timeline, not in Settings; /settings/recording displays active hold
counts, held and non-reapable byte capacity impact on ?tab=retention, and
per-block hold-pin status on ?tab=cameras.
Camera recording and storage settings
Opening /settings/recording requires at least one of
settings.recording.view, settings.recording.manage, or
settings.recording.operate (listing camera sources and relay-eligible stream
profiles on ?tab=cameras and ?tab=policy additionally requires
devices.view).
Selecting or changing the writer, optional reader, or optional retention delete
s3_compatible archive credential on /settings/recording?tab=archive
additionally requires settings.credentials.manage (see
Credential Management), because
listing reusable credentials is governed by that permission. A user holding
settings.recording.manage without settings.credentials.manage can register
and activate archive destinations and toggle archive_enabled, while the
credential selectors render as disabled with only the bound credential's
redacted name and an explanation of the missing permission.
Every state-changing LiveView event, Core action, and operations call re-checks
the specific permission for that operation (manage versus operate, plus
devices.cameras.recordings.hold when accepting archive loss on a held entry)
against the current actor rather than relying on mount-time access. None of the
settings.recording.* permissions grant recorded footage playback (which keeps
devices.cameras.recordings.view plus devices.view) or recording hold
placement and release (which require devices.cameras.recordings.hold), and
footage-read or hold access does not open /settings/recording.
No RBAC permission opens, closes, or modifies the deployment recovery gate from the UI or API. The view reports Core and NVR recovery-gate state read-only; gate changes remain under deployment control outside CNPG backups and GitOps rollback (see Camera Recording & NVR and NVR runtime and replicated storage).
Custom role profiles
When the built-in roles do not match a team's needs, an administrator can create a custom role profile: a named bundle of specific permission keys. A profile assigned directly to a user becomes that user's base profile instead of the system profile for their built-in role. If no direct profile is assigned, the built-in role's system profile remains the base.
A reusable user group can also have one role profile. Every current membership adds that group's profile permissions to the user's base permissions. Membership in several profiled groups produces the set union of all those permissions, so a permission granted through more than one profile has no additional effect. A group profile augments the base profile; it does not replace it.
Users relying on a built-in profile get personal API credentials
(settings.api_credentials.manage) and MCP (settings.mcp.manage) because
those default to every role. Omit them on a directly assigned custom profile to
hide Settings -> API Credentials, MCP Sessions, and to refuse /mcp
and MCP OAuth consent. Omit plugins.view on the same profile to hide
Dashboard Packages and the Edge Ops add-on catalog.
The four built-in roles also exist as system role profiles (Admin,
Operator, Helpdesk, Viewer). System profiles cannot be edited or deleted;
custom profiles can.
Managing role profiles in the UI
Role profiles are managed under Settings -> Auth/Users:
- Settings > Auth > RBAC - browse the permission catalog and create, edit, or delete custom role profiles. Each profile is given a name, an optional description, and a checklist of permissions. The same page lists reusable user groups, where an administrator can assign or clear one group role profile.
- Settings > Auth > Users - view users and assign each user a role or a custom role profile.
Managing role profiles requires the Manage RBAC policies
(settings.rbac.manage) permission; managing users requires Manage users and
auth (settings.auth.manage). Loading group assignments also requires
identity.user_groups.view, and changing them requires
identity.user_groups.manage. The manage permissions default to admin;
group viewing defaults to operator and admin.
Managing dashboard audiences for a group
From Settings > Auth > RBAC, select Dashboards beside a user group to manage that group's explicit view grants. Authored dashboards and installed dashboard packages are loaded and paged independently.
This surface is not an exclusive access list:
- A public authored dashboard is already available to users with analytics access, while a public packaged dashboard is available to authenticated users. Public rows are read-only here, and no redundant group grant is created.
- An explicit
viewgrant can be added or removed. An existingeditgrant is stronger, remains read-only in this editor, and is never downgraded or removed by the view control. - Source-wide
view_allpermissions can grant access independently of the selected group's explicit grant. - Granting group view to a private packaged dashboard also changes its visibility to shared. Removing that grant does not automatically make it private again.
Changing an authored dashboard audience requires settings.rbac.manage,
analytics.dashboards.share, and authority over that target as its owner,
through an explicit edit grant, or through analytics.dashboards.edit.
Changing a packaged dashboard audience similarly requires
dashboards.packages.share and target authority as owner, through an explicit
edit grant, or through dashboards.packages.view_all.
The editor reloads current server state before applying a change. If another administrator or a dashboard-local sharing control changed the same row after it was displayed, the stale operation is rejected and the affected list reloads.
Managing role profiles via the API
Role profiles can also be managed programmatically through the admin API (API key or bearer token, with the same RBAC permission required):
| Method | Endpoint | Purpose |
|---|---|---|
GET | /api/admin/role-profiles/catalog | List the full permission catalog. |
GET | /api/admin/role-profiles | List all role profiles. |
GET | /api/admin/role-profiles/:id | Show one role profile. |
POST | /api/admin/role-profiles | Create a custom role profile. |
PATCH | /api/admin/role-profiles/:id | Update a custom role profile. |
DELETE | /api/admin/role-profiles/:id | Delete a custom role profile. |
A create or update request supplies a name, an optional description, and a
permissions array of permission keys (for example devices.view,
services.run). Use the catalog endpoint to discover valid keys.
A user always has a built-in role (the rung) and may have a directly assigned role profile. The direct profile replaces the built-in system profile as the user's base; profiles assigned through current user-group memberships are then added to that base. Mapping an IdP group onto a profile does not require putting that profile in the default-role dropdown. That dropdown is only the four built-in rungs. See Group Permission Mapping.
How roles are assigned to users
Each user record carries a built-in role and, optionally, a direct role profile. Assign or change those from Settings > Auth > Users, or let SSO apply them from Settings > Authorization mappings on each sign-in. Assign a role profile to a reusable user group from Settings > Auth > RBAC; every current member receives that profile's permissions in addition to their base profile.
When a user's role, direct profile, group membership, group profile, or a profile's permission list changes, ServiceRadar invalidates the affected RBAC caches after the change commits. Sensitive operations reload the user's current memberships and profiles instead of trusting permissions retained by an older page or session. Removing or deleting a profile clears both direct-user and user-group assignments that referenced it.
Recommendations
- Give most people
viewerorhelpdesk; reserveoperatorfor staff who actively maintain inventory and rules. - Keep the number of
adminaccounts small -- that role can manage users, credentials, plugins, and remote access. - Use a custom role profile when a team needs an unusual mix of permissions (for example, view-everything plus run sweeps but no editing).