Tenant Management Service¶
Idea¶
Tenant Management is a central service that provides the possibility to manage a tenant, its related subtenants, as well as related data.
Access¶
For accessing this service you need to have the respective roles listed in Tenant Management roles and scopes.
Basics¶
Tenants¶
A tenant is an organization-specific logical environment for your data. A tenant typically represents a legal entity, such as a company or corporation. In this context MindSphere is a multi-tenant architecture.
Subtenants¶
A subtenant is an organization-specific logical environment for the data of a cooperating legal entity. A subtenant typically represents a subset of the tenant's data which the tenant wants to share with one or more of its customers.
Tenant Information of a Tenant¶
The tenant information stores the following parameters:
- country
The home base of your legal entity - displayName
The brand name which is shown in the MindSphere environment - name
The name which is shown in the URL of the tenant - prefix
An ID which is used by developers to identify relevant code components - type
The tenant type:USER
,DEVELOPER
orOPERATOR
Company logo¶
A tenant can display its own company logo in the UI. For this purpose logos of type .jpg, .png, or .gif with a maximum file size of 1 MB can be uploaded.
Legal Information of a Tenant¶
A tenant can display its own legal/branding information, which is defined as legal links of type www
, phone
, and mail
. When tenant branding is enabled, it automatically creates the region global
and sets the default language to English. Tenants can be located in different regions with different legislation, which might require displaying different legal links depending on their location. For this case you can define custom regions and using country codes specify which countries belong to each region. One country can only belong to one region. You can also define different languages and add them to multiple regions. For each region you can define individual legal links in multiple languages.
The customized legal links are displayed for all users of the tenant except tenant admins, who still see the original legal links of MindSphere. The tenant's location and the language settings of the web browser determine, which legal links are displayed.
Info
You must enable tenant branding in order to create a subtenant!
Features¶
The Tenant Management Service exposes its API for realizing the following tasks:
- Retrieve tenant-specific information
- Manage your own legal information
- Create, retrieve and delete subtenants
Example Scenario¶
Providing Legal Information¶
The administrator of a machine manufacturer updates the legal information of the tenant with their own company's legal information in order to provide it to other tenants and subtenants.
For details see Create your provider information.
Creating Subtenants¶
The administrator of a machine manufacturer wants to create a subtenant for one of their customers in order to share relevant machine data with them.
For details see :
Use the Tenant Management API to create a Subtenant.
Developing Subtenancy-Aware Applications.
Related Links¶
Any questions left?
Except where otherwise noted, content on this site is licensed under the Development License Agreement.