You need the Organization Administrator role to perform the tasks on this page.
Based on your licensing plan, your organization can have one or more tenants.
On Enterprise plans, after you've reached 5 tenants, you must open a ticket for Support to add new tenants for you.
To create a new tenant:
- In the Tenants page, click Add Tenant. The Add Tenant panel opens.
- Enter a name for your tenant.
You can enter up to 32 alphabetical or numeric characters, starting with a letter. No spaces or special characters are allowed.
You can change the tenant name later, but there are consequences.
- (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:
- Choose the region for your tenant.
Your data and resources for this tenant are hosted in the selected region, but the region of the services you activate for the tenant can differ. For more information, see Tenant and Service Regions.
You cannot change the tenant region after saving. If you need to change it later, you must open an SLA ticket.
- Select the services that you want to make available within the new tenant.
The Orchestrator service is mandatory. You can select any of the available services. Services are only available if you have free licenses for that service.
If the selected service is only available in a different region than the selected tenant region, a globe icon appears next to the service and you can hover your mouse over it to see where the service will be hosted.
- Click Save to create the tenant and close the panel.
All your free licenses are automatically allocated to the new tenant.
- If you want, you can redistribute robot and service licenses to reduce the number on this tenant, or reduce the number on another tenant to free up licenses for this tenant.
Once created, 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.
You can change the name and active services for an existing tenant.
- Click at the right end of the row and select Tenant Settings.
The Edit services for tenant panel opens:
- 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.
- From the list to the right of the name, select a different header color for the tenant, if needed.
- Select the check boxes for the services you want to have available in this tenant, or clear them to remove services.
You can only provision a service if you have a license available for that service.
If you remove existing services, their corresponding allocated licenses become available for other tenants. The service cannot be accessed anymore.
You can't remove the Orchestrator service.
- Click Save.
A confirmation message appears in the top right of the screen.
You can individually enable or disable the services within a tenant. You can disable them if you want to retain their data, but need to free up a license, or stop use of that service temporarily, or you can enable it to make it available again to your users.
To enable or disable services:
- On the Tenants page, click the arrow to the left of the tenant name to show the list of services for that tenant.
- At the right end of the row, click the enable/disable toggle to enable or disable the service as needed:
Services are enabled and disabled shortly and a confirmation message appears at the top right of the window.
Disabled services appear as grayed out. Enabled services appear in the usual blue and clicking the name opens the service.
Changing the name of any of your tenants greatly impacts your previous UiPath Automation Cloud 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.
Enterprise customers can choose the region of tenants when creating them. However, after creating the tenant you cannot change the region yourself.
If you need to move a tenant to a different region, open an SLA ticket and request the move to one of the available regions.
- In the Tenants page, click next to a tenant and select the Delete option. The Delete Tenant window is displayed.
- Click Delete to confirm your action. The tenant, along with all its services and any data within them, is deleted. After deletion, it is no longer being displayed in the Tenants page.
A tenant can be deleted if none of the processes within its Orchestrator service are being executed.
After deleting a tenant, all its assigned licenses are freed up and available for you to use with other tenants.
Disabled tenants remain displayed on the Tenants page, but their services are not accessible. All the services data is kept. You can later enable the tenant to access its services again.
- On the Tenants page, click at the right end of the row of a tenant and select Disable Tenant.The Disable Tenant window opens.
- Click Disable to confirm your action. The tenant, along with all its services, is then disabled.
After disabling a tenant, all its assigned licenses are freed up and become available for the other tenants.
If a tenant is disabled, you can enable it if you need to access its services.
- On the Tenants page, click at the right end of the row of a disabled tenant and select Enable Tenant.
The tenant is enabled shortly and all its services are accessible again.
After enabling a tenant, for your convenience, all the licenses available in your organization are allocated by default to the tenant.
You can later edit the licenses allocated to each tenant according to your needs.
If there are both named and multiuser licenses available for the same product, we allocate the named user licenses by default. You cannot allocate both to the same tenant.
Updated 2 months ago