Skip to main content
Version: 0.10

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.
A global role never opens a tenant's data

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 grantsWrite grants
Server ConfigurationNothing in this versionNothing in this version
Global Deployment ManagementThe Organization pageChanging the organization's name, description and logo, and deleting the organization
Global Deployment OwnerNothing in this versionNothing in this version
Global Deployment BillingNothing in this versionNothing in this version
User ManagementThe Users & Roles page: the user list, each user's details, Security tab and role assignments, and the role listsInviting, editing, blocking, unblocking and deleting users; enforcing MFA and password change; Reset MFA; assigning global and tenant roles; creating, editing and deleting roles
Tenant ManagementThe Tenants page, and visibility of every tenant in the organizationCreating, 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.

Global Deployment Management Write can delete everything

It is the only check on deleting the organization, with every tenant and user in it. See Organization.

Tenant permissions​

Permission (console label)Read grantsWrite grants
Asset ManagementAsset lists and asset pages for every asset type, charts and aggregations, asset field files; the Decommissioning, License Optimization and Vulnerabilities modulesCreating, 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 ManagementDashboardsDeleting a dashboard
Scans ManagementScan templatesCreating, editing and deleting scan templates
Reports ManagementReports and report templates, and downloading themCreating and deleting reports; uploading, replacing and deleting report templates
Scanners ManagementSensors, their self-test results and upgrade checkEnrolment tokens, renaming, changing mode, running a self-test, revoking sessions and deleting sensors
Fields ManagementField definitionsCreating, editing and deleting custom fields
Integrations ManagementIntegration instancesConnecting, editing, enabling or disabling and deleting integration instances
Layouts ManagementDetail and creation layoutsEditing layouts
Scan ResultsA scan's Changes and FindingsEditing or deleting a change entry, resolving conflicts and approving validation
Scans ScheduleSchedulesCreating, editing, pausing and deleting schedules
Tasks ResultsScan history and run detailsRun now, running an isolated scan with a file, testing an integration connection, deleting a run
Wizard ResultsWizard analysers, runs, findings and exclusionsRunning an analysis, completing and excluding findings, removing exclusions
Module CoverageThe Coverage moduleCoverage 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​

RolePermissions
Global AdminRead and Write on every global permission
AuditorRead on every global permission, no Write
Projects AdminTenant Management, Read and Write
WorkerNone. Tenant access comes from tenant roles alone

Tenant roles​

RolePermissions
Project AdminRead and Write on every tenant permission except Module Coverage; can switch the tenant's modules
Project ReporterRead on every tenant permission except Module Coverage
Project Read OnlyRead on every tenant permission except Module Coverage

Project Reporter and Project Read Only currently grant exactly the same permissions.

Coverage needs a custom role

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​

  1. Users & Roles, then the Global Roles or Tenant Roles tab.
  2. Create role.
  3. Enter a Name and, optionally, a Description.
  4. For each permission, toggle Write and Read as needed.
  5. 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.

Tenant roles are not limited the same way

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​

WhoGlobal roleTenant roles
Organization ownerGlobal AdminProject Admin in the tenants they work in
Platform administrator who manages tenantsProjects AdminAs needed
Auditor of the organization's setupAuditorProject Read Only where needed
Tenant administratorWorkerProject Admin in their tenant
AnalystWorkerA custom role with Read on everything and Write on what they run (for example Tasks Results, Scan Results, Reports Management)
Read-only userWorkerProject Read Only
Grant the narrowest scope that works

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​