Tenant

A Tenant is a virtual regrouping that is used to separate Users, Devices and manage access control. In our platform, Tenants could be considered as different companies or business units that need privacy from each other.

Tenants are nested. This means that each Tenant has a parent, which creates an overall Tenant Tree structure.

The system integrates a default or Root Tenant which represents the platform owner. This Root Tenant is managed like other standard Tenants except it does not have a parent tenant.

A second Root Tenant exists by default for testing purposes. It is used to carry out tests regularly in an isolated environment, to check that all the main features behave as expected on a deployed Kamea environment. You can read more about these tests in the integration testing docs.

You can read more about Tenants in the access control guide.

Tenant details

• Name: a standard name without character restriction used to be displayed in the interface.
• Short name: a short version of the name that is used in the URL or short name need in the interface. This short name cannot be changed and must be unique in the system.
• Description: a text sharing information about the Tenant.
• Logo: a picture used in the interface as main logo when a user of the Tenant is connected. This allows a high level of customization of the graphical interface for the end customer.
• State: an indicator of the enables or disables state of the Tenant. A disabled Tenant should not be used.

Tenant Features

List Tenants

Permission

• read.tenant OR belong to the Tenant

Feature

• Users can retrieve a list of Tenants available to them
• Administrators can have a full list, where Tenant-specific users will only see their assigned Tenants
• this enabled Users to see the Tenant details

Create Tenant

Permission

• create.tenant

Feature

• Users can create a new Tenant by providing all the necessary information
• Users can only create Tenants that are children of existing Tenants (no new Root Tenant can be created)

Update Tenant

Permission

• update.tenant

Feature

• Users can update all information of a Tenant, except for the short name.

Delete Tenant

Permission

• delete.tenant

Feature

• Users can delete a Tenant
• This deletes all data of the Tenant, except for events and telemetries
• Users of this Tenant will only be deleted if they do not belong to any other Tenant

Enable and Disable a Tenant

Permission

• update.tenant

Feature

• Users can disable or enable a Tenant
• This does not delete any existing data from the Tenant
• A disabled Tenant cannot be used: Users can login but do not have any feature available, and the Tenant does not store additional device data