Roles and permissions
Velum Edge has two kinds of role:
- A global role grants permissions over the organization itself: its settings, its tenants, its users and roles.
- A tenant role grants permissions inside one tenant: its assets, scans, sensors, reports and so on. Tenant roles are assigned per tenant, so the same person can be an administrator in one tenant and read-only in another.
Tenant data is checked against tenant roles only. A Global Admin with no tenant role in a tenant can see that the tenant exists (if they hold Tenant Management) but cannot read its assets, scans or reports. Give yourself a tenant role in the tenant when you need to work in it.
Where roles live
System management → Users & Roles, tabs Global Roles and Tenant Roles. Each tab lists the roles with their number of users, their type (System for built-in, Custom for your own) and description. Select a role to see its permissions.
Viewing roles needs User Management at Read; creating, editing and deleting them needs User Management at Write. Roles are assigned to people on the user's Roles tab, see Assigning roles.
How permissions work
Each permission has two independent levels, Read and Write:
- Read lets you view.
- Write lets you create, change, run or delete.
Write does not include Read. A role with Write but not Read on, say, Asset Management can change assets through the API but cannot list them, so tick both for anyone who edits.
A user's permissions are the combination of all their roles: globally, the union of their global roles; in a tenant, the union of their tenant roles in that tenant.
Global permissions
| Permission (console label) | Read grants | Write grants |
|---|---|---|
| Server Configuration | Nothing in this version | Nothing in this version |
| Global Deployment Management | The Organization page | Changing the organization's name, description and logo, and deleting the organization |
| Global Deployment Owner | Nothing in this version | Nothing in this version |
| Global Deployment Billing | Nothing in this version | Nothing in this version |
| User Management | The Users & Roles page: the user list, each user's details, Security tab and role assignments, and the role lists | Inviting, editing, blocking, unblocking and deleting users; enforcing MFA and password change; Reset MFA; assigning global and tenant roles; creating, editing and deleting roles |
| Tenant Management | The Tenants page, and visibility of every tenant in the organization | Creating, renaming, re-describing, changing the logo of and deleting tenants; switching any tenant's modules |
"Nothing in this version" means no screen or API endpoint checks the permission today. Granting it has no effect.
It is the only check on deleting the organization, with every tenant and user in it. See Organization.
Tenant permissions
| Permission (console label) | Read grants | Write grants |
|---|---|---|
| Asset Management | Asset lists and asset pages for every asset type, charts and aggregations, asset field files; the Decommissioning, License Optimization and Vulnerabilities modules | Creating, editing, merging and deleting assets (one by one or in bulk), CSV import and its template, uploading field files; module settings, runs and actions in Decommissioning and License Optimization; Vulnerabilities settings and Clear data |
| Dashboard Management | Dashboards | Deleting a dashboard |
| Scans Management | Scan templates | Creating, editing and deleting scan templates |
| Reports Management | Reports and report templates, and downloading them | Creating and deleting reports; uploading, replacing and deleting report templates |
| Scanners Management | Sensors, their self-test results and upgrade check | Enrolment tokens, renaming, changing mode, running a self-test, revoking sessions and deleting sensors |
| Fields Management | Field definitions | Creating, editing and deleting custom fields |
| Integrations Management | Integration instances | Connecting, editing, enabling or disabling and deleting integration instances |
| Layouts Management | Detail and creation layouts | Editing layouts |
| Scan Results | A scan's Changes and Findings | Editing or deleting a change entry, resolving conflicts and approving validation |
| Scans Schedule | Schedules | Creating, editing, pausing and deleting schedules |
| Tasks Results | Scan history and run details | Run now, running an isolated scan with a file, testing an integration connection, deleting a run |
| Wizard Results | Wizard analysers, runs, findings and exclusions | Running an analysis, completing and excluding findings, removing exclusions |
| Module Coverage | The Coverage module | Coverage layout, settings and update requests |
Being able to see a tenant at all needs at least one tenant role there (any permission) or Tenant Management.
Two tenant-level actions are not permissions:
- Switching modules is allowed for the tenant's built-in Project Admin and for anyone with Tenant Management at Write. A custom role with every permission ticked does not allow it.
- Modules that are switched off are refused for everyone, whatever their permissions.
Built-in roles
Every organization is created with these roles. They are marked System, their System field reads Yes, and they cannot be edited or deleted.
Global roles
| Role | Permissions |
|---|---|
| Global Admin | Read and Write on every global permission |
| Auditor | Read on every global permission, no Write |
| Projects Admin | Tenant Management, Read and Write |
| Worker | None. Tenant access comes from tenant roles alone |
Tenant roles
| Role | Permissions |
|---|---|
| Project Admin | Read and Write on every tenant permission except Module Coverage; can switch the tenant's modules |
| Project Reporter | Read on every tenant permission except Module Coverage |
| Project Read Only | Read on every tenant permission except Module Coverage |
Project Reporter and Project Read Only currently grant exactly the same permissions.
None of the built-in tenant roles includes Module Coverage, so on their own they do not open the Coverage module. To use it, create a tenant role with Module Coverage (Read, and Write to change its settings) and assign it alongside the built-in one.
Creating a custom role
- Users & Roles, then the Global Roles or Tenant Roles tab.
- Create role.
- Enter a Name and, optionally, a Description.
- For each permission, toggle Write and Read as needed.
- Select Create.
To change a custom role, open it, adjust the name, description or toggles and select Save. To remove it, select Delete and confirm with Delete role: everyone who held it loses its permissions.
Rules:
- The name is 2 to 64 characters (letters, digits, spaces and
_ : - . \ /) and must be unique among the organization's global roles, or among its tenant roles; the description is up to 500 characters. - A tenant role is defined once for the organization and then assigned per tenant. Editing it changes it in every tenant where it is assigned.
Safeguards
The server applies these rules whatever client is used.
You cannot hand out more than you hold. A global role can be created, edited, granted or taken away only by someone who already holds every permission in it. This covers inviting a user with a role, assigning or removing a role on the user's Roles tab, and editing a role (both its current and its new permissions must be within yours). Roles a change leaves untouched may be bigger than yours.
The organization always keeps an administrator. An active administrator is an Enabled user holding User Management at Write. The server refuses any change that would leave the organization without one:
- deleting the last active administrator;
- blocking the last active administrator;
- taking away the global role that makes them one;
- editing a global role so it no longer has User Management Write, or deleting that role, when it is what keeps the last administrator one.
Built-in roles are fixed. System roles cannot be edited or deleted.
Your own account is protected from yourself. You cannot delete, block or reset the MFA of your own account from Users & Roles.
The "cannot hand out more than you hold" rule applies to global roles only. Anyone with User Management at Write can assign any tenant role, including Project Admin, to any user in any tenant, themselves included.
Designing role assignments
| Who | Global role | Tenant roles |
|---|---|---|
| Organization owner | Global Admin | Project Admin in the tenants they work in |
| Platform administrator who manages tenants | Projects Admin | As needed |
| Auditor of the organization's setup | Auditor | Project Read Only where needed |
| Tenant administrator | Worker | Project Admin in their tenant |
| Analyst | Worker | A custom role with Read on everything and Write on what they run (for example Tasks Results, Scan Results, Reports Management) |
| Read-only user | Worker | Project Read Only |
Most people need no global permission at all. Keep Global Admin, and above all Global Deployment Management Write, to the few people who own the organization.
See also
- Tenants and users
- Account security
- API authentication: API tokens act with their user's roles