Create a New Tenant

1. Log in as the supplied admin user, a system administrator, or a member of the Supervisors group.

2. Select Tenants (formerly Multi-Tenancy) from the Administration menu. The Multi-Tenancy work area appears. This lists the defined tenants in your environment, including the default tenant, Visual Data Discovery.

3. To add a new tenant, select Add Tenant .

   The Create New Tenant work area opens.

4. Enter a name for the new tenant in the Tenant Name field. The name must be at least four characters long.

5. Assign at least one administrator. Select one of the following options:

   • Select Assign Existing User As Admin to select an existing user as the administrator for the tenant. Assign a user by choosing Select Users, then select one or more users from the list.

     Select Apply to confirm your choices. The users are added as tenant administrators to the Administrators group in this tenant when you complete tenant creation.

     Important: If you want the tenant admin to also be a user or admin in the Visual Data Discovery (default) tenant, you must create the user account in the Visual Data Discovery (default) tenant, and then add them as an admin during tenant creation or after you create the tenant account.

   • Select Create A New Admin User to create a new user account as the administrator for the tenant. Supply a user name and password for the new user in the Username, Password, and Confirm Password fields.

     The new user is assigned to the new tenant account as a tenant administrator assigned to the Administrators group in this tenant when you complete tenant creation. They are not added to the Visual Data Discovery tenant, and cannot be added to the Visual Data Discovery tenant later.

     Note: When you create a user within a tenant, the Login Name is checked against the list of all users across all tenants in the Composer Instance. If the Login Name is in use, you will see an error message. Select a different Login Name for that user.

   No other fields are required, but you can add Custom Attributes for the tenant as needed. See Specify Custom Tenant Attributes.

6. Select Create Tenant.

   The new tenant is created and is automatically enabled. The administrator you assigned is included as a tenant user (see List and Review Users) and member of the tenant's Administrators group.

   To disable the tenant, see Enable or Disable Tenants.

Only the Administrators group and no other user groups are part of the tenant until administrator users create more user groups. See Manage User Groups.

You can use the Accounts API endpoints to see and define the reserved attributes for your tenants. This includes defining an email.replyToAddress and email.senderDisplayName for sharing dashboard reports and self service reports. See Scheduled Self Service Reports and Dashboard Report Prerequisites and zoomdata.properties Properties.

API documentation is provided in your environment at this link: https://<composer-URL>/composer/swagger-ui.html.

Remove Tenants