Permissions
A role is a set of these permissions, and a user has the union of the permissions of all their roles. Every page of the interface and every API endpoint asks for one permission, and the server checks it on each request. The scope of the user applies on top of the permissions.
| Permission | Grants | Pages and endpoints |
|---|---|---|
inventory.view | View findings, dependencies, assets and the dashboard, within the user's scope. | Dashboard, Findings, Dependencies, Assets; /findings, /packages, /assets, /dashboard/summary and their exports |
agents.view | View agents and agent releases, within the user's scope. | Agents page; GET /agents, GET /agent-releases |
agents.manage | Register, change and remove agents, create enrollment and cluster tokens, roll out agent updates. | Add host, Add cluster, Register agent, Update, Rotate key, Delete; /agents write endpoints, /cluster-tokens, /enroll-tokens, /agent-releases (upload) |
scans.view | View scan runs, task runs and scheduled tasks. | Scans and tasks page, Scan history, Running now; /scans, /task-runs, /tasks |
scans.run | Start a vulnerability scan. | Start a scan; POST /scans |
tasks.manage | Change the schedule of a task and run it now. | Scheduled tasks; PUT /tasks/{name}, POST /tasks/{name}/run |
reports.view | View and download reports and report templates. | Reports page, downloads; /reports, /report-templates |
reports.manage | Create, change and delete reports and report templates. | New report, Recreate, Delete, templates; POST /reports, /report-templates |
alerts.view | View alert channels, rules and events. | Alerts page, all tabs; /alert-channels, /alert-rules, /alert-events |
alerts.manage | Change alert channels and rules. | New channel, New rule, Test; the write endpoints of alerts |
cpe.view | View the NVD dictionary status and the CPE mappings. | CPE mappings page; /cpe-mappings, /nvd-cpes/status, /nvd-cpes/search |
cpe.manage | Import the NVD dictionary and change the CPE mappings. | Import dictionary, New mapping; /nvd-cpes/import, /cpe-mappings write endpoints |
settings.manage | Change the NVD, AI and automatic agent update settings. | NVD API key, AI backend, Agent updates on the Settings page; /settings/* |
users.manage | View, create, change and delete users, and assign their roles and scope. | Users section; /users |
roles.manage | Create and change roles. | Roles section; /roles write endpoints |
findings.triage | Record decisions on findings (not affected, affected, fixed), and set their owner and ticket. | Triage button on the Findings page; PUT /finding-decisions, DELETE /finding-decisions/{id} |
The Settings page itself, the account section and the sign-out are open to every signed-in user.
Built-in roles
| Role | Permissions |
|---|---|
admin | All of the above, for every cluster and node. |
viewer | inventory.view, agents.view, scans.view, reports.view, alerts.view, cpe.view. |
The built-in roles are re-created at every start, so their permissions follow the server version. Custom
roles are kept as they are. A user who holds users.manage or roles.manage can only grant the
permissions they hold themselves.