Skip to main content
Version: 0.10

Tenants and users

Both live in System management (the gear icon in the top bar): Tenants for tenants, Users & Roles for user accounts. User accounts belong to the organization; access to a tenant's data comes from the tenant roles a user holds in that tenant.

Tenants​

A tenant is a separate inventory inside the organization, with its own assets, sensors, integrations, scans, reports, fields and layouts. Every console URL for tenant data carries the tenant's id: /t/<tenant-id>/….

Who sees which tenants​

  • Users holding Tenant Management (Read or Write) see every tenant in the organization on the Tenants page and in the tenant switcher.
  • Everyone else sees only the tenants they hold at least one tenant role in.

Creating a tenant​

Needs Tenant Management at Write.

  1. System management → Tenants → Create tenant.
  2. Enter a Name and, optionally, a Description.
  3. Select Create.

Rules: the name is 2 to 64 characters (letters, digits, spaces and _ : - . \ /) and must be unique in the organization; the description is up to 500 characters. An organization can hold up to 1000 tenants by default (a deployment can change it).

A new tenant starts with:

  • you as its Project Admin, so you can open it straight away;
  • the standard asset fields, the default detail and creation layouts for every asset type, the default dashboards and the read-only system Excel report template;
  • a default logo;
  • every module switched on.

It has no sensors, integrations or scans. The getting-started guide walks through the next steps.

Editing a tenant​

Open the tenant from the Tenants list. The page shows:

ItemNotes
AvatarThe tenant's logo. Upload a PNG or JPEG (up to 5 MB by default, at most 4096 pixels per side), or Use default to restore the generated one. Saved as soon as it uploads
Name, DescriptionSame rules as when creating. Select Save to keep them
AssetsNumber of assets in the tenant (read only)

The icon next to the title opens the tenant's dashboard in a new browser tab.

Editing needs Tenant Management at Write.

Deleting a tenant​

Delete on the tenant's page, then Delete tenant to confirm. Needs Tenant Management at Write.

Deleting a tenant deletes its data

Everything the tenant holds goes with it: assets and their change history, scan templates, schedules and history, sensors and their enrolment tokens, integrations, reports and report templates, fields, layouts, dashboards, module data and the role assignments for that tenant. There is no undo.

Tenant modules​

The optional modules (Coverage, Decommissioning, License Optimization and Vulnerabilities) are switched per tenant, inside the tenant itself: Settings → Global → Modules. See Modules.

  • Everyone with access to the tenant sees the table, with each module's last change.
  • Only a user with Tenant Management at Write, or the tenant's built-in Project Admin, can flip a switch. The change is saved immediately.
  • A module that is off disappears from the navigation and search for everyone in the tenant, and the API refuses its requests with HTTP 403. Its data is kept and comes back when the module is switched on again.

Users​

System management → Users & Roles → Users lists the organization's user accounts: name, email, state, phone, job title, location, last login, and whether MFA is enforced and enabled. The list is searched by name, email, job title or location and paged on the server.

Viewing users needs User Management at Read; every change below needs User Management at Write.

Inviting a user​

  1. Users & Roles → Users → Invite user.
  2. Enter the Email address.
  3. Tick the Global roles to give the new account, if any.
  4. Select Invite.

The invitation creates the account straight away, in the Invited state, and queues an invitation email with a link. When the person opens the link they choose their name and password (the password policy applies) and the account becomes Enabled.

The invitation does not grant tenant access. Once the account exists, open it and add tenant roles on its Roles tab (see Assigning roles).

Rules and limits:

  • An email address can belong to only one account across the whole platform, so inviting an address that already has an account is refused. These refusals are counted per inviting user: after 10 within the lockout window (one hour by default) further invitations are refused for that hour.
  • You can only give global roles whose permissions you hold yourself, see Safeguards.
  • The invitation link stays valid for the deployment's session lifetime, see Sessions.
Invitations depend on email delivery

Invitation emails are only delivered when email sending is set up for the deployment, which is off by default. Without it the account is created and stays Invited, but the person never receives the link, and the console has no way to show or resend it. Delete the account and invite again once email sending is set up.

Account states​

StateMeaningHow it is reached
EnabledNormal accountInvitation accepted, email confirmed, or unblocked
SuspendedBlocked by an administratorBlock user
InvitedInvitation sent but not yet acceptedInvite user
UnverifiedSelf-registered, email address not yet confirmedSelf-registration

What Suspended does:

  • Signing in is refused with the message "User cannot login", but only after a correct password, so the message does not reveal the account's state to someone guessing.
  • Every request from a session the user already had is refused with HTTP 403, and so is every request made with one of their API tokens.
  • Nothing is deleted. Sessions are not ended either: if the account is unblocked before a session expires, that session works again.
TODO

The console has a dedicated "account blocked" screen for suspended users, but the backend refuses a suspended sign-in with an error instead of reaching it, so the user sees the error on the sign-in form. Confirm which behaviour is intended.

Blocking and unblocking​

On the user's General tab, select Block user to suspend the account or Unblock user to enable it again. Only Enabled and Suspended accounts can be switched; Invited and Unverified accounts cannot. You cannot block yourself, and you cannot block the last active administrator (see Safeguards). Blocking and unblocking each send a notification.

Prefer blocking to deleting when someone leaves: the account and its history are kept and the decision can be reversed.

The user page​

Open a user from the list. The page has three tabs.

General

  • Avatar, Name, Phone, Location, Job Title and Language, saved with Save. The email address cannot be changed. The name may contain only letters and spaces (2 to 64 characters); job title and location take letters, digits, spaces and - . , _ + ' (up to 128 characters).
  • Two-Factor Authentication: whether the user has an authenticator enrolled, with Reset MFA (see below).
  • MFA Enforce: Yes makes the user enrol an authenticator at their next sign-in before they can do anything else, and stops them turning it off.
  • Password Change Enforce: Yes makes the user choose a new password at their next sign-in.
  • Block user / Unblock user and Delete.

An Invited account shows a notice that the invitation has not been accepted yet.

Security (read only)

FieldContent
StateCurrent account state
Last Login, Last Login IpTime and source address of the last successful sign-in
MFA Enabled, MFA EnforceWhether a factor is enrolled, and whether one is required
Password Change EnforceWhether a new password is required at next sign-in
Email VerifiedWhether the address has been confirmed
Creation Date, Creation IpWhen the account was created
MFA Changed Date, MFA Changed IpLast change to the account's second factor, or N/A
Password Change Date, Password Change IpLast password change, or N/A

Only successful sign-ins update Last Login; failed attempts do not. The Download activity logs button is shown but not available yet.

Roles: see Assigning roles.

Enforcing MFA and password changes​

Both switches act at the user's next sign-in; existing sessions carry on. Enforcement is per account: there is no organization-wide switch, so set it on each account, including new ones as they join. See Account security.

Resetting a user's MFA​

Use this when someone has lost their authenticator.

  1. On the user's General tab, select Reset MFA next to Two-Factor Authentication.
  2. Confirm with Reset MFA.

The user's enrolled factor is removed and every session they have open is signed out. They then sign in with their password alone, or, if MFA is enforced, are asked to enrol a new authenticator at their next sign-in. A notification is sent.

You cannot reset your own MFA this way; turn your factor off from your profile instead, where it is confirmed with your password and a code. The button only appears when the user has a factor enrolled.

Check who is asking

Reset MFA only after confirming that the request really came from the account's owner. A reset requested by someone else is how accounts are taken over.

Deleting a user​

Delete on the user's General tab, then Delete user to confirm. The account, its avatar and its authenticator secret are removed; there is no undo. You cannot delete yourself or the last active administrator.

Assigning roles​

On the user's Roles tab:

  • Global roles: pick the roles from the list, then Save.
  • Tenant roles: one list per tenant (Tenant <name>:). Pick the roles for each tenant, then select the Save under the tenant lists. A user with no role in a tenant cannot see it, unless they hold Tenant Management.

Global role changes are checked against your own permissions and against the last-administrator rule, see Safeguards.

Email and these flows​

Invitation, email confirmation and password-reset mails are only delivered when email sending is set up for the deployment, which is off by default. Without it:

FlowWhat happens
Invite userAccount created as Invited; the person never receives the link
Self-registrationAccount created as Unverified and cannot be confirmed
Forgot passwordThe console says to check your email, but nothing arrives; an administrator cannot reset a password for someone

See also​