Subscribe

UiPath Automation Suite

The UiPath Automation Suite Guide

Managing tenants and services

Managing tenants


Tenants allow you to model your organization structure, separating your business flows and information just like in real-life organizations. They are containers where you can organize your services and manage them for a group of users. For example, you can create tenants for each of your departments and decide what services you want to enable for each, based on their needs. In each tenant, you can have one instance of each of the services.

About tenants

Orchestrator in Automation Suite

All tenants contain an Orchestrator service.

While in standalone Orchestrator, your Orchestrator instance can include several tenants, in Automation Suite you have one Orchestrator service in each tenant.

An Automation Suite tenant is different from an Orchestrator tenant.

Tenant in Automation SuiteTenant in Standalone Orchestrator
Is a subdivision of the Automation Suite organizationIs a subdivision of the Orchestrator instance
Includes one Orchestrator serviceIs a part of Orchestrator
Includes several other services (UiPath products), all within Automation SuiteIs not in the same medium as your other UiPath products and interacts with them through integrations

The default tenant

When you get started with an Automation Suite organization, your first tenant, called DefaultTenant, is automatically created. All the licenses available according to your licensing plan are allocated to your default tenant so that it is ready for use without requiring further license configuration.

You can create multiple tenants for your organization's needs. Multitenancy enables you to isolate data within your Automation Suite organization. This feature facilitates automating different departments from your company and lets you control access to data per department.

Users can see all tenants within the organization by default and all the services they contain. This allows users to request access and engage in using them based on their business needs. The level of access granted for each user is defined by their roles within the organization and within each service. See Managing access for more information.

The Tenant page

To access options for a tenant, go to Admin and then select the tenant in the left pane.
The page allows you to access all the relevant information about your tenant and includes options for managing each tenant and service within the tenant.

1124

Tenant statuses

You can see the status of a tenant on the Tenants page and it can be:

  • Enabled - the tenant is active and can be accessed by users.
  • Disabled - the tenant is not active and unavailable to users.

 

Switching tenants

If your organization has multiple tenants and you have access at the service-level to more than one tenant, you can switch between tenants while on the page of a tenant-specific service.

To switch the context to a different tenant, click the tenant list in the top right and select another tenant:

1057

The page refreshes and then shows data for the newly selected tenant.

Adding tenants

  1. Go to Admin.
  2. In the left pane, click the Create a new tenant icon (plus) next to the Tenants heading.
    The Create a new tenant wizard opens.
  3. In the Tenant Name field, type a name for the new tenant.
  4. (Optional) From the list to the right of the name, choose a color to show in the header when this tenant is selected. This can help users easily tell which tenant they're currently on:
1270
  1. Click Next in the bottom right.
  2. On the Add Services step, select the checkboxes for the services that you want to make available within the new tenant.
    Services are only available if you have free licenses for that service.
  3. Click Next.
  4. On the License Allocation step, edit the quantities for each type of license, if needed, to set the licenses that you want to allocate to the new tenant.
  5. Click Create.

The wizard closes and a message is displayed in the top right, indicating that tenant creation started. Allow a few minutes for the process to complete.
After the tenant is created, it is displayed in the list of tenants in the left pane.

New tenants are available to users from the tenant picker in the top right of the page. The services within the tenant are available to users who have been granted the required service-level roles.

Editing tenants

When editing tenant settings, you can change the name, color, enable, disable, or delete the tenant.

Changing the tenant name or color

  1. Go to Admin and select the tenant in the panel on the left.
  2. Click Settings.
    The Settings page for the selected tenant opens.
  3. Edit the tenant name if needed.
    Changing a tenant's name disconnects your Robots and Mobile Orchestrator users, and invalidates any pending user invites. See Impact of Changing Tenant Names.
  4. From the list to the right of the name, select a different header color for the tenant, if needed.
  5. Click Save Changes at the bottom of the page.

A confirmation message appears in the top right of the screen.

Impact of changing tenant names

Changing the name of any of your tenants greatly impacts your previous UiPath Automation Suite service configurations:

  • Robots configured at Orchestrator services level are disconnected. Reconnect your Robots, entering the new URLs.
  • Service URLs previously bookmarked don't work anymore. Send your users the new URLs.
  • Mobile Orchestrator users are disconnected. Send them the new service URLs to connect again.
  • User invites sent before the change are not valid anymore. Send new invites for your colleagues who haven’t joined yet.

 

Enabling or disabling a tenant

Disabled tenants remain visible to organization administrators in the Tenants panel of the Admin page, but the tenant and its services are no longer available to users. Also, the licenses that were allocated to the tenant are released and returned to the organization's pool of licenses.
All data for the services is kept. You can later enable the tenant to access its services again.

  1. Go to Admin and select the tenant in the panel on the left.
  2. Click Settings.
    The Settings page for the selected tenant opens.
  3. Under Disable Tenant, click Enable or Disable, depending on the current state of the tenant.
    A warning dialog opens.
  4. In the dialog, click Enable or Disable to proceed.

A loading icon is shown next to the tenant in the Tenants panel on the left while the change is being processed.
After the icon disappears:

  • If you disabled the tenant, Disabled appears to its right and the tenant and its services are no longer available to users.
  • If you enabled the tenant, it is now restored as it was before being disabled. All licenses that it used before are also re-allocated if they were available in the organization pool. The tenant and its services are now available for use.

Deleting a tenant

When deleting a tenant, you remove the tenant from your organization and also delete all of its services and any service data.

After deleting a tenant, all its licenses are freed up and available for you to allocate to other tenants.

If any processes are being executed in the tenant's Orchestrator service, you cannot delete the tenant.

  1. Go to Admin and select the tenant in the panel on the left.
  2. Click Settings.
    The Settings page for the selected tenant opens.
  3. Under Delete tenant permanently, click Delete, depending on the current state of the tenant.
    The Delete Tenant dialog opens.
  4. In the field, enter the tenant name, exactly as it is shown, including the letter case, and then click Delete.

A loading icon is displayed next to the tenant in the Tenants panel while the deletion is in progress. When complete, the tenant is removed from the Tenants panel.

 

Editing tenant licenses

In Admin > tenant > Licenses, you can see information about the licenses currently allocated to each tenant.

To change the license quantities, click Edit allocation in the top right corner.

For more information, see Allocating licenses to tenants.

 

Managing services


In each tenant, you can provision each of the services for which you have a license. You can then manage and work in that service as needed, within the context of the tenant.
In the case of organization-level services such as UiPath Apps, data is not isolated by tenants. The same service is available across your organization.

 

Provisioning or removing services


You can:

  • provision the services you need as part of the setup process when you add a tenant
  • for an existing tenant, provision new services or remove existing ones whenever you need, as described on this page.

Provisioning services

By provisioning a service to an existing tenant, you are adding to the services that are available for use within the context of that tenant.

To provision services for an existing tenant:

  1. Go to Admin and select the tenant in the panel on the left.
  2. Click Services.
    The Services page for the tenant opens, showing the services that are currently provisioned.
  3. In the top right, click Add Services:
942

If you have already provisioned all services, the button is not available.
The Add Services panel opens at the right of the window.

  1. Select the checkbox for each service that you want to add to this tenant.
    Services that require a license and for which you do not have one available are not shown.
  2. Click Add at the bottom of the panel.
    The panel closes and the tenant is briefly unavailable while the selected services are being provisioned.

When finished, the new services are displayed on the Services page.

Removing services

Removing (or deleting) a service from a tenant means the service is no longer available to users while in the context of that tenant. If the service is provisioned in other tenants, it remains available for use in other tenants.

Licenses

  • In the case of a service with a service instance license, such as UiPath Automation Hub, removing the service from the tenant also frees up one license unit for the service. You can then use the license to provision the service in a different tenant, if needed.
  • In the case of a service with user licenses or runtimes (robot licenses) allocated, such as UiPath Orchestrator, the licenses that were used for the service are returned to the organization's pool of licenses and they can be re-allocated as needed.

To remove services from a tenant:

  1. Go to Admin and select the tenant in the panel on the left.
  2. Click Services.
    The Services page for the tenant opens, showing the services that are currently provisioned.
  3. On the card of the service you want to remove, click and then select Remove.
    The Remove option is not available for the Orchestrator service because it must be present in every tenant.
    A confirmation dialog opens.
  4. In the field, type the name of the service, exactly as it is shown (including capitalization), and then click Delete.
    The dialog closes and, on the Services page, the service is removed from the list of services for the tenant.

While in the context of the tenant, the removed service is no longer available to users.
The licenses for the service, if any, are now available for use in other tenants.

 

Enabling or disabling services


When you disable a service:

  • Any existing license allocation for the service is removed and licenses are returned to the organization pool.
  • The service data is retained and the service remains available to organization administrators in case you want to re-enable it later.
  • The service is no longer available to users within the tenant for which it was disabled.

Licenses: When you enable a service, we attempt to re-allocate licenses for the service as they were before being disabled, but within the limit of the licenses currently available for the organization. Therefore, it is possible that previous license allocations are not fully restored if insufficient licenses are available.

To enable or disable a service:

  1. Go to Admin and select the tenant in the panel on the left.
  2. Click Services.
    The Services page for the tenant opens, showing the services that are currently provisioned.
  3. On the card of the service you want to remove, click and then select Disable or Enable, depending on the current status of the service.
  4. If you are disabling the service, a confirmation dialog opens. Click Disable to proceed.

After a short period, a confirmation message appears at the top of the page and the service status changes on the Services page. Disabled appears on the card of each disabled service.

 

Other service options


Also see:

  • Managing accounts and groups for information about assigning permissions to users for Automation Suite and for the various services
  • API keys for information about how you can authenticate to the API of Automation Suite services.
  • (Orchestrator only) Exporting logs.

Updated 2 months ago


Managing tenants and services


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.