Create and manage tenant organizations

When you use Sigma Tenants, you can create and manage tenant organizations from the parent organization. You can perform most tenant management tasks from the UI, or programmatically using the Sigma REST API.

Any user assigned the Admin account type in the Sigma organization used as the parent organization can access and configure tenant organizations. Users in tenant organizations can only access content and settings in their tenant.

📘

If you have several unconnected Sigma organizations and want to link those organizations as parent and tenant organizations with Sigma Tenants, contact your Sigma Account Executive. Converting an existing organization to a tenant organization cannot be undone.

Requirements

You must be assigned the Admin account type to create and manage tenant organizations.

Create a tenant organization

To create a tenant organization:

1. In the Administration portal, go to Tenants.
2. On the Tenants tab, click Create tenant.
3. For Tenant name, specify a name to use for the tenant. The name is appended to the organization slug for your organization. Members of your tenant organization navigate to that URL to sign in to the tenant.
4. (Optional) Select the Edit icon to change the cloud deployment region for your tenant. You can select different regions for the same cloud provider.
5. Click Create.

The tenant organization is created. Next, configure required settings on the tenant, such as setting up authentication and connections to data sources.

📘

The number of tenants that you can create depends on your contract with Sigma.

Create a tenant from a team

You can choose to create a tenant organization based on an existing team in your Sigma organization.

When you create a tenant organization from a team:

• Account types in the parent organization are recreated in the tenant organization.
• Users in the team are recreated in the tenant organization. All users receive an invitation email with details about the new tenant organization, and can continue to sign in to the parent organization.
• Documents and workspaces associated with the team are not recreated in the tenant.

To create a tenant organization from a team:

1. In the Administration portal, go to Teams.
2. Select Create tenant from team.
3. For Tenant name, specify a name to use for the tenant. The name is appended to the organization slug for your organization. Users in the tenant organization navigate to that URL to sign in to the tenant.
4. (Optional) Select the Edit icon to change the cloud deployment region for the tenant. You can select different regions for the same cloud provider.
5. (Optional) Select the Send welcome message checkbox. All users in the team receive an invitation email. When you select the Send welcome message checkbox, you can provide an additional message to include in the invitation email.
6. Click Create.

The tenant organization is created. Next, configure required settings on the tenant, such as setting up authentication and connections to data sources.

Configure and manage a tenant organization

After you create a tenant, you must configure the tenant organization. For each tenant organization, set up required settings such as authentication for the organization and connections to data sources. To perform these steps in a tenant organization, you must open the tenant as an admin.

After creating a tenant organization, complete the following steps:

1. Open the tenant as an admin, then configure a connection for the tenant.
2. Open the tenant as an admin, then set up authentication for each tenant organization.
3. Invite users to the tenant. See Manage a tenant organization.
4. Deploy content to tenant organizations.

When you create a tenant, some basic tenant configurations are inherited from the parent organization, such as themes, branding, and export restrictions. After creating a tenant, you can customize the following settings for a specific tenant:

• Set up custom workbook themes.
• Customize email branding.
• Configure export restrictions.
• Customize the time zone and locale and language used in the organization.

Other configurations are not inherited, but can be set up differently for each tenant. For example, set up integrations with tenant-specific Microsoft Teams tenants or Slack workspaces:

• Set up a tenant-specific Slack integration for exports and notifications to Slack.
• Set up a tenant-specific Microsoft integration for exports to Microsoft Teams or Microsoft SharePoint.

If you use version tags to manage which versions of documents get deployed, such as in a software development lifecycle (SDLC) use case, create version tags in relevant tenant organizations. See Create and manage version tags.

Perform admin tasks in tenant organizations with impersonation

To access a tenant as an admin and configure the tenant, use impersonation to open the tenant as an admin:

1. In the Administration portal of the parent organization, go to Tenants.

2. Locate the tenant that you want to configure, then select More > Open tenant as admin.

   Your browser tab loads the tenant organization. You can perform admin tasks in the tenant organization.

If you use audit logging, tasks that you perform after opening a tenant as an admin are attributed to the TenantAdminRobot user.

💡

As an admin user in a parent organization, you can also use the Sigma API to perform operations in tenant organizations. For details, including an example Python script, see Impersonate users for API calls.

For more details about impersonation, see Impersonate users.

Manage a tenant organization

After creating a tenant, you can change the name and URL, and view all teams, account types, and members associated with a tenant:

1. In the Administration portal, go to Tenants.
2. Locate and select the tenant that you want to manage.

When viewing the tenant details:

• To change the tenant name or URL (organization slug), click Edit.

• To review the users, teams, account types, and members of a tenant organization, review the Tenant Management section. You can perform the following tasks in a tenant without opening the tenant as an admin from the parent organization:

  • Invite users to the tenant organization.
  • Create teams in the tenant organization.
  • Create custom account types for the tenant organization.
  • View all configured connections in the tenant organization.
  • Grant deployment capabilities to allow the tenant to deploy content to other tenant organizations.

Programmatically create and manage tenants

To programmatically create and manage tenants, use the Sigma REST API:

• Create a tenant organization (POST /v2/tenants)

Then, using credentials in each tenant organization or as an admin in the parent organization impersonating each tenant for API calls, perform configuration steps like the following:

1. Create a connection (POST /v2/connections)
2. Invite users by creating a member in a tenant (POST /v2/members)
3. Create a team (POST /v2/teams)
4. Create a version tag (POST /v2/tags)

You can also perform deployment tasks programmatically. See the following:

• Deploy content from a parent organization to one or more tenants
• Deploy content from one tenant organization to one or more tenants