Skip to content

Manage Tenants

The goal of multi-tenancy is to maximize resource sharing across multiple users (while hiding the fact that these users are on the same server) and to ensure optimal performance. You can register tenants in the Management Console, allowing tenants to maintain separate domains for their institutions.

When multi-tenancy is used, certain tenants can sometimes become inactive for a long period of time. By default, if the inactive period is 30 minutes, the tenant is unloaded from the server memory. This requires the tenant to log in again before sending requests to the server.

If required, you can change the default time allowed for tenant inactiveness by adding the -Dtenant.idle.time=<time_in_minutes> java property to the product startup script ./iot-server.sh file for Linux and iot-server.bat for Windows) as shown below:

JAVA_OPTS
-Dtenant.idle.time=30 \

All the Entgra IoTS tenants can access the public store, but tenants are always required to log in to view their private store. Before carrying out any tasks on the Management Console, we highly recommend you to change the default super tenant administrator password. You can also create a new tenant.

Changing the Default Password

Before carrying out any tasks on the Management Console, we highly recommend you to change the default super tenant administrator password.

Follow the instructions below to change the default super tenant administrators password:

  1. Open a command prompt: On Windows, go to Start -> Run, type cmd at the prompt, and press Enter. On Linux/Solaris, establish a SSH connection to the server or log in to the text Linux Console.
  2. Execute one of the following commands, where <IOTS_HOME> is the directory where you installed the product distribution:
OS Command
Linux/Solaris sh <IOTS_HOME>/bin/iot-server.sh
Windows <IOTS_HOME>\bin\iot-server.bat --run
  1. Log into the Management Console using the following URL format: https://<IOTS_HOST>:<IOTS_HTTPS_PORT>/admin/carbon

By default, <IOTS_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified. By default, <IOTS_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

For example: https://localhost:9443/admin/carbon/

  1. Enter the username as admin and the password as admin.
  2. Click Sign in.
  3. Switch to the Main tab.
  4. Click List under Users and Roles and then click Users.

    Main Tab

  5. Click Change Password in the Actions column, in-line with the user admin and set a new password.

  6. Click Change.
  7. Log out and log in again with the new credentials.

Adding a New Tenant

You can add a new tenant in the management console and then view it by following the procedure below. In order to add a new tenant, you should be logged in as a super user.

  1. Click Add New Tenant in the Configure tab of the IoTS management console.

    Main Tab

  2. Enter the tenant information in Register A New Organization screen as follows, and click Save.

    Main Tab

    Parameter Name Description
    Domain The domain name for the organization, which should be unique (e.g., abc.com). This is used as a unique identifier for your domain. You can use it to log into the admin console to be redirected to your specific tenant. The domain is also used in URLs to distinguish one tenant from another.
    Select Usage Plan for Tenant The usage plan defines limitations (such as number of users, bandwidth etc.) for the tenant.
    First Name/Last Name The name of the tenant admin.
    Admin Username The login username of the tenant admin. The username always ends with the domain name (e.g., admin@abc.com)
    Admin Password The password used to log in using the admin username specified.
    Admin Password (Repeat) Repeat the password to confirm.
    Email The email address of the admin.
  3. After saving, the newly added tenant appears in the Tenants List page as shown below. Click View Tenants in the Configure tab of the management console to see information of all the tenants that currently exist in the system. If you want to view only tenants of a specific domain, enter the domain name in the Enter the Tenant Domain parameter and click Find.

    Main Tab

Editing a Tenant Record

Follow the instructions below to edit a tenant record:

  1. Log into the Management Console.
  2. Switch to the Configure tab and click View Tenants.
  3. Search for the tenant based on the tenant domain name.
  4. Click Edit.
  5. Edit the tenant details as required. Note that the domain, tenant ID and usage plan can not be modified.
  6. Click Update.
  7. Optionally, click Deactivate, if you wish to deactivate the tenant.

Customizing Email Templates for Tenants

If you wish to update the email template for a tenant, you can do so by following the steps given below:

Prerequisite

Add a new tenant. For more information, see adding a new tenant. Example: The added tenant has the user name admin@abc.com.

  1. Start the server.

  2. Access the IoTS Management Console using one of the following URLs:

  3. Accessing the console via HTTP:http://<HTTP_HOST>:<HTTP_PORT>/carbon/ Example: http://localhost:9763/carbon/

  4. Accessing the console via HTTPS: https://<HTTPS_HOST>:<HTTPS_PORT>/carbon/ Example: https://localhost:9443/carbon/image

  5. Enter the username and password of the tenant you created and click Sign-in. Example: username: admin@abc.com and password: tenant123$.

  6. Click Browse in the Main tab of the WSO2 IoTS management console.

  7. Navigate to email-templates by entering /_system/config/email-templates in the Location field, and clicking GO.

    Main Tab

  8. Click the template you want to update. Example: Click user-enrollment.

    Main Tab

  9. Click Edit as text.

    Main Tab

  10. Select Plain Text Editor to edit the template style sheet.

    Main Tab

  11. Click Save to save the updated template.

Sharing iOS Platform Configurations among Tenants

The following content guides you on how to share the iOS platform configurations among tenants.

Note This approach is not recommended for your production environment. If you want to enable multi-tenancy for iOS platform configurations in a production environment, you need to configure the platform configuration for each tenant via the device management console. For more information, see iOS Platform Configurations.

Before you begin Configure the iOS platform configurations of the super tenant. For more information, see iOS Platform Configurations. The default super tenant username is admin and the password is admin.

Follow the steps given below:

  1. Copy the iOS platform configurations of the super tenant:

  2. Log in to the IoT server’s core carbon console: https://<IOTS_HOST>:9443/carbon

  3. The default HTTPS port of the core profile is 9443. If you port offset WSO2 IoT Server, make sure to use the correct port to access the carbon console.

  4. Click Main > Resources > Browse.

  5. Enter /_system/config/ios as the Location and click Display as text.

    Main Tab

  6. Copy the content that appears in the text area.

    Main Tab

  7. Create an XML file named ios-default-platform-configuration.xml in the <IOTS_HOME>/conf/etc/device-mgt-plugin-configs/mobile directory.

  8. Paste the content you copied in step 1 to the ios-default-platform-configuration.xml file you created in step 2.

  9. Restart WSO2 IoT Server.