Skip to main content
Version: 0.10

Core concepts

A handful of ideas explain most of the platform. Read this page once and the rest of the documentation will make sense.

They nest:

Organization​

Your Organization is the top level of everything you do in Velum Edge. It holds:

  • Your users: every account that can sign in to your Organization
  • Your tenants: one or more, described below
  • Your roles and settings: global and tenant roles, sign-in and password policies
  • Your data: assets, scans, reports, all of it inside tenants

Organizations are independent of one another. Two customers of Velum Edge share no assets, no users, no roles and no visibility into each other:

You do not choose or switch Organizations; you work inside yours. Organization settings are under System management → Organization. See Organization.

Signing up creates a new Organization

Where self-registration is enabled (it is by default; a deployment can turn it off), registering on the sign-in page creates a new, separate Organization with the new account in it. It never joins an existing one. To bring someone into your Organization, invite them instead: see Tenants and users.

Registration and invitations rely on an email (a confirmation link, an invitation link), and those emails are only delivered when email sending is set up for the deployment. It is off by default.

The API calls the same thing a deployment; the console always says Organization.

Tenants​

A tenant is an isolated customer or business unit inside your Organization. It is the boundary the product organises work around: each tenant has its own asset inventory, sensors, integrations, scan templates, schedules, runs, reports, dashboards, fields, layouts and module switches.

How many tenants you need depends on who you are.

If you secure your own organisation: one tenant​

Most customers use Velum Edge for themselves. In that case you have a single tenant, and it holds everything.

Do not create a tenant per department, site or environment. Tenants are a hard wall, not a filter: splitting one estate across several of them loses the single, correlated view Velum Edge exists to give you, because assets in different tenants are never matched or merged. To slice one inventory, use fields, tags and filters instead.

If you serve several independent organisations: one tenant each​

Tenants exist for the case where the estates genuinely are separate:

  • Managed security providers: one tenant per client company
  • Groups: one tenant per subsidiary that runs its own IT
  • Acquisitions: a tenant per acquired company while its network is still separate
Who you areTenantsWhy
A company securing itself1One estate, one correlated inventory
A provider with 12 clients12Client data must never mix
A group of 3 independent subsidiaries3Separate IT, separate teams, separate reporting
A company with 5 departments on shared IT1Use fields and filters, not tenants

What isolation means​

Each tenant's assets are stored separately from every other tenant's, so no query, scan, report or export in one tenant reaches another's data. Two tenants can each contain a host called dc-01 and they will never be correlated, merged or counted together.

Users and tenant access​

User accounts belong to the Organization, not to a tenant. Access to a tenant comes from the tenant roles a user holds in it, so one Organization can hold teams that see entirely different things:

Analyst A cannot see Client B's assets at all. A user sees a tenant in the tenant switcher when they hold a role in it, or when they hold the global Tenants management permission, which lists every tenant in the Organization for administration. Working with a tenant's data always takes a tenant role.

Whoever creates a tenant is made its Project Admin. See Tenants and users and Roles and permissions.

Assets and asset types​

An asset is one real thing in your environment. Every asset has one of five types, and each type has its own list under Assets in the sidebar:

TypeWhat it holds
EndpointsWorkstations, servers, tablets and other devices
SubnetsNetwork subnets
ApplicationsApplications, with ownership, classification, continuity and dependencies
UsersUser identities
LicensesSoftware licences and entitlements

An asset is not a record from a single source. Your EDR, your directory and a cloud inventory may each report the same laptop. Velum Edge matches those records to one asset with several contributing sources, so the inventory reflects reality rather than the number of tools.

See Assets and Asset types.

Fields​

Everything an asset carries is held in fields, defined per tenant under Settings → Fields. Each field has an origin:

OriginWho owns it
SystemThe platform's core asset model
StandardStandard properties the platform provides
IntegrationContributed by an integration, usually prefixed with its name (for example cs_*)
Scripted, CachedCalculated by the platform from other fields
CustomCreated by your tenant

Only Custom fields can be created, edited or deleted by a tenant; every other origin belongs to the platform or to the integration that contributed it. A field has a type (Text, Integer, Decimal, Date, Date & time, Text block, Dropdown, Multi-select, IP address, Team, File, Boolean, Integration, Tags or Asset reference). See Fields.

How fields are arranged on an asset's page, and on its creation form, is set per asset type under Settings → Layouts. See Layouts.

Sensors​

A sensor is a Velum Edge collector you deploy inside your network. It does the actual work of gathering data for a tenant: every integration run, every API call to a source system and every packet a network scan sends happens on a sensor. The sensor connects out to the console over HTTPS; nothing connects in to it.

Integrations do not run "somewhere in the cloud" separately from your sensors. That is why internal systems never have to be reachable from the internet for Velum Edge to read them.

A sensor belongs to a tenant, reports its own health, and can be enabled or disabled without losing the assets already discovered through it. See Sensors.

Integrations​

An integration is one configured connection to a source of asset data, added from Settings → Integrations → Marketplace and assigned to the sensor that can reach it. A tenant typically has several: an EDR, a directory, a cloud subscription, a vulnerability scanner, the active network scanner. No single source knows about everything, and each covers a blind spot of the others.

Some integrations discover assets, and can create new ones; others only enrich assets that already exist, for example by resolving their owner.

An integration on its own collects nothing. It is the scan template that uses it, run on demand or on a schedule, that makes the sensor fetch data. See Integrations.

Scans: templates, schedules and runs​

TermWhat it is
Scan templateOne integration, that integration's settings for this scan (what to collect, time-outs), what to do with new, updated and missing assets, and optional rules. Under Scans → Templates.
ScheduleA template plus a cron expression, so it runs on a timetable. Created paused unless enabled straight away. Under Scans → Scheduled.
RunOne execution of a template, started with Run now or by a schedule. It passes through stages from Queued to Finished. Under Scans → History.

See Scanning.

Changes and conflicts​

A run never writes straight onto assets. It turns what the sensor collected into change entries (an asset to create, an asset to update), listed on the run's Results tab, and the template's actions decide what happens to each: apply it automatically, hold it for approval, or ignore it.

Two things can make a run stop and wait for a person:

  • Needs review (a conflict): a change matched more than one existing asset, and someone has to say which one it belongs to.
  • Awaiting approval: the changes are resolved, and the template asks for them to be approved before they reach the inventory.

See Reviewing a scan.

Findings and vulnerability findings​

The word findings means two different things in the console:

  • A run's findings (its Findings tab) are the raw records the sensor collected from the source, before they were turned into changes. They are there so you can see exactly what a source returned.
  • Vulnerability findings are vulnerabilities reported against assets by a vulnerability scanner integration, open and fixed, shown in the Vulnerabilities module.

Merging is irreversible​

When two assets turn out to be the same thing, you can merge them from the asset page, choosing field by field which values to keep. The other asset is deleted when the merge runs, and what pointed at it (owners, linked assets, vulnerabilities, scan changes not yet applied) moves to the asset you keep. Its change history keeps the old asset.

There is no undo and no split

A merge cannot be reversed, and there is no way to split one asset into two. Check the pair before you merge.

The Wizard finds likely duplicates for you.

Modules​

Modules are optional screens, each switched on or off per tenant under Settings → Global: Coverage, Decommissioning, License Optimization and Vulnerabilities. A module is on unless someone has switched it off for the tenant. A switched-off module disappears from the sidebar and its API calls are refused. See Modules.

How they fit together​

Integrations are used by scan templates, runs on a sensor turn source data into change entries, applied changes maintain the inventory, and everything else reads from it: all of it inside one tenant, inside your Organization.