Skip to content

Tenant

Tenants are licensed features. To perform any interaction with a tenant besides listing them and getting them, you must have a license with the rbac feature enabled.

Tenants control what objects a user can see via the DRP API.

Field Definition
Description Description is a string for providing a simple description
Documentation Documentation is a string for providing additional in depth information.
Members Members is a map of objects in this tenant.

The key of the map is the name of the object. e.g. machines
The value of the map is a list of object keys.
Meta Meta contains the meta data of the object.

The type of this field is a key / value map/dictionary.
The key type is string.
The value type is also string.

The general content of the field is undefined and can be an arbritary store.
There are some common known keys:

color - The color the UX uses when displaying
icon - The icon the UX uses when displaying
* title - The UX uses this for additional display information. Often the source of the object.

Specific Object types use additional meta data fields. These are described at:
https://docs.rackn.io/stable/redirect/?ref=rs_object_metadata
Name Name is the name of the tenant
Users Users is a list of users that can participate in this tenant.

Object visibility restrictions based on a tenant are processed before roles are processsed, which means that a role granting access to an object that is not allowed by the tenant will be ignored.

By default, users are not members of a tenant, and can therefore potentially see everything via the API (subject to role based restrictions).