Skip to main content
Version: 0.10

Organization

An organization is the top level of Velum Edge. It holds every tenant, every user account, and the global and tenant roles those users are given. Users of one organization never see another organization's tenants, users or roles.

Organization and deployment are the same thing

The console calls it an Organization. The API calls the same object a deployment (for example /api/v1/ou/deployments/get), and some permission names use that word too. They mean the same thing.

Opening the Organization page​

Select the System management icon (the gear) in the top bar, then Organization in the System Management sidebar. The gear is shown only to users who hold at least one global permission.

Each System Management section needs its own global permission at Read:

SectionNeeds
OrganizationGlobal Deployment Management (Read)
TenantsTenant Management (Read)
Users & RolesUser Management (Read)

A section you have no permission for is left out of the sidebar. See Roles and permissions.

What the page shows​

ItemWhat it isEditable
AvatarThe organization's logo. Upload replaces it, Use default puts the generated default backYes
NameThe organization's name, shown in the top bar under your nameYes
DescriptionFree textYes
UsersNumber of user accounts in the organization; the arrow opens Users & RolesNo
TenantsNumber of tenants; the arrow opens TenantsNo
CreditsCredit balance held for the organizationNo
Subscription ModeTrial, Basic or UnlimitedNo

Select Save to keep changes to the name and description, or Cancel to discard them. A logo change is saved as soon as the upload finishes.

Changing the name, description or logo needs Global Deployment Management at Write.

Rules for the fields​

  • Name: 2 to 64 characters. Letters, digits, spaces and _ : - . \ / are accepted.
  • Description: up to 500 characters.
  • Logo: PNG or JPEG, up to 5 MB by default (a deployment can change it), at most 4096 pixels on either side and 4096 × 3072 pixels in total. The image is re-encoded as PNG when it is stored.
TODO

Confirm what Credits and Subscription Mode control. A new organization starts with 0 credits in Trial mode, and no console screen or API endpoint changes either value; the code does not show any feature that reads them.

Deleting the organization​

Delete, below the card, removes the whole organization:

  • every tenant, with its assets, scans, sensors, integrations, reports and settings;
  • every user account, including your own;
  • the organization's roles and logo.

The console asks you to type the organization's name before it enables Delete organization. Once the deletion finishes you are signed out.

There is no undo

Deletion cannot be reversed from the console or the API. Database rows are removed first, then the search indices and stored files. If you might need the data again, export it first (for example from the asset lists, see Reports).

Who can delete it​

The API refuses the deletion unless the caller holds Global Deployment Management at Write. No other check is made on the server: the typed-name confirmation is a console safeguard only, and the last-administrator safeguards that protect user accounts do not apply here.

Treat Global Deployment Management Write as the most powerful permission

Anyone who holds it can delete the organization with one API call. Give it only to the people who own the organization. The built-in Global Admin role includes it.

Self-registration​

Where it is enabled, the sign-in page shows Create account. Signing up does not add you to an existing organization. It creates a new organization:

  1. A new organization is created, named New Deployment <first part of your email address>. Rename it on the Organization page.
  2. The organization gets the built-in global and tenant roles (see Roles and permissions).
  3. Your account is created in the Unverified state and given the Global Admin role in the new organization.
  4. A confirmation email is queued with a link to activate the account.

Until the address is confirmed, you can sign in but the session goes no further than the screen asking you to confirm your email. Once confirmed, the account is Enabled. The new organization has no tenants yet: create one under System management → Tenants (see Tenants and users).

Confirmation depends on email delivery

Confirmation emails are only delivered when email sending is set up for the deployment, which is off by default. Without it, a self-registered account stays Unverified and cannot get past the confirmation screen. To join an existing organization, ask one of its administrators for an invitation instead.

Turning self-registration off​

Self-registration is on by default. A deployment that should only admit invited users turns it off with the platformConstants.selfRegistrationEnabled setting. When it is off, the sign-in page offers no Create account link, the registration page says registration is closed, and the API refuses auth/register. Accounts that signed up before it was turned off can still confirm their email.

Sign-up is also limited per source address and can require a CAPTCHA, see Account security.

See also​