Skip to main content

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.

PermissionGrantsPages and endpoints
inventory.viewView findings, dependencies, assets and the dashboard, within the user's scope.Dashboard, Findings, Dependencies, Assets; /findings, /packages, /assets, /dashboard/summary and their exports
agents.viewView agents and agent releases, within the user's scope.Agents page; GET /agents, GET /agent-releases
agents.manageRegister, 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.viewView scan runs, task runs and scheduled tasks.Scans and tasks page, Scan history, Running now; /scans, /task-runs, /tasks
scans.runStart a vulnerability scan.Start a scan; POST /scans
tasks.manageChange the schedule of a task and run it now.Scheduled tasks; PUT /tasks/{name}, POST /tasks/{name}/run
reports.viewView and download reports and report templates.Reports page, downloads; /reports, /report-templates
reports.manageCreate, change and delete reports and report templates.New report, Recreate, Delete, templates; POST /reports, /report-templates
alerts.viewView alert channels, rules and events.Alerts page, all tabs; /alert-channels, /alert-rules, /alert-events
alerts.manageChange alert channels and rules.New channel, New rule, Test; the write endpoints of alerts
cpe.viewView the NVD dictionary status and the CPE mappings.CPE mappings page; /cpe-mappings, /nvd-cpes/status, /nvd-cpes/search
cpe.manageImport the NVD dictionary and change the CPE mappings.Import dictionary, New mapping; /nvd-cpes/import, /cpe-mappings write endpoints
settings.manageChange the NVD, AI and automatic agent update settings.NVD API key, AI backend, Agent updates on the Settings page; /settings/*
users.manageView, create, change and delete users, and assign their roles and scope.Users section; /users
roles.manageCreate and change roles.Roles section; /roles write endpoints
findings.triageRecord 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​

RolePermissions
adminAll of the above, for every cluster and node.
viewerinventory.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.