Managing tenants

Tip: For examples on how you can use tenants to create separation of resources within your organization, see Examples of platform modelling.

 

Adding tenants

To create a new tenant:

1. Go to Admin.
2. In the left panel, click + next to the Tenants header to add a tenant:
   
   

   

   
   

   The Create a new tenant wizard opens on the first step, General.

3. Enter a name for your tenant in the Tenant Name field.

   You can enter up to 32 alphabetical or numeric characters, starting with a letter. No spaces or special characters are allowed.

   Important: You can change the tenant name later, but there are consequences.

   See Changing the Tenant Name below.

4. (Optional) From the Color list to the right of the Tenant Name field, choose a color to show in the header when this tenant is selected.

   This can help users easily tell which tenant they're currently working in:

   
   

   

   
   
5. If you want to use this tenant as a canary tenant, select Use as a canary environment.

   For more information, see Using a Canary Tenant below.

   Note: If you already have a canary tenant, even if it is currently disabled, you cannot select the checkbox to create another canary tenant.
6. From the Tenant Region list, choose the region for hosting your service data for this tenant.
   Important: You cannot change the tenant region yourself after you create the tenant. If you need to change it later, you must open a Support ticket .

   When a tenant and associated data are moved to a new region, the tenant ID and folder ID are changed. You must update your projects with the new tenant and folder IDs.

7. Click Next to proceed to the next step.
8. Select the checkboxes for the services that you want to make available within the new tenant.

   The Orchestrator service is mandatory. Other services are only available if you have free licenses for the service.

   
   

   

   
   

   Note: If a service is only available in a different region than the selected tenant region, the region where that particular service will be hosted is displayed on the card for the service. For more informations, see Tenant and service regions.
9. Click Next to proceed to the next step.

   On the License Allocation step, we automatically fill in the license quantities to allocate all your free licenses to the tenant.

10. If you want to keep some of your available licenses for other tenants, reduce the quantity for each license type to the amount you want to allocate to this tenant.

    The number of licenses you have available is displayed under each license type. This is the number of licenses you have before creating this tenant and out of which you can allocate to this tenant.

11. Click Create to close the wizard and create the tenant.

The new tenant is added to the Tenants panel on the left.

The loading icon is displayed while tenant provisioning is in progress.

After the icon disappears:

• The tenant and its services are ready for use.
• The tenant is available to users from the tenant picker in the top right of the page, but they only have read-only access.

Next steps: To be able to work in the tenant, you or a service administrator must assign roles and licenses for the services in the new tenant to users. For more information, see:

• Service-level roles
• Allocating user licenses.

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.
   Important: Changing a tenant's name disconnects your Robots and Mobile Orchestrator users, and invalidates any pending user invites. See Impact of Changing Tenant Names below.
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 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.

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.

Note: 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.