- Getting started
- Host administration
- Organizations
- Authentication and security
- Licensing
- Tenants and services
- Accounts and roles
- External applications
- Notifications
- Logging
- Troubleshooting
Automation Suite Admin Guide
Configuring the SAML Integration
You can connect your Automation Suite organization to any identity provider (IdP) that uses the SAML 2.0 standard. This page describes the overall process by showing a few sample SAML integration configurations.
The SAML Integration is designed such that it can be implemented gradually, with no disruption to existing users.
The main phases of the process, described in more detail on this page, are:
- Clean up inactive user accounts
- Configure the SAML integration
- Transition existing users to sign in with SAML SSO
- Configure permissions and robots for new users
- Discontinue use of local accounts (optional)
With the SAML integration, you cannot search all users and groups from your identity provider. Only provisioned directory users are available for searching.
Only local users appear at the organization level. Just-in-time provisioning adds directory users, so they do not show up on the Accounts & Groups management page.
The SAML SSO Configuration page displays an incorrect Assertion Customer Service URL.
Workaround: To address this issue, configure the Assertion Customer Service URL in the IDP without the partition ID. For example, the original URL: https://{your-domain}/91483651-d8d6-4673-bd3f-54b0f7dc513a/identity_/Saml2/Acs would become https://{your-domain}/identity_/Saml2/Acs
This workaround has two caveats:
-
IDP initiated login flows will not work as expected.
-
This issue has been fixed in 2023.4. Upon upgrading to 2023.4+ you will need to change the Assertion Customer Service URL to include the partition ID.
To set up the SAML integration, you need:
- An Automation Suite organization with an Enterprise or Enterprise Trial license.
-
Administrator permissions in both Automation Suite and your third-party identity provider.
If you don't have administrator permissions in your identity provider, you can work with an administrator to complete the setup process.
-
UiPath® Studio and UiPath Assistant version 2020.10.3 or later, so that you can set them up to use the recommended deployment.
Switching from Azure Active Directory integration
If you are currently using the for authentication, we recommend remaining on the AAD integration because it is more feature-rich.
If you do decide to switch from the AAD integration, you must manually replace role assignation done through directory groups with direct role assignation to the directory accounts so that you do not have to completely recreate your access schema.
If your organization recycles email addresses, it is important to remove all inactive user accounts before you configure the SAML Integration.
When you enable the integration, local accounts present in Automation Suite can be linked with the directory account in the external identity provider that uses the same email address. This account linking occurs when the directory account user with the email address signs in for the first time. The identity from your identity provider inherits any roles that the local account had so that the transition is seamless.
Because of this, with inactive local accounts present in Automation Suite, there is a risk that local accounts and directory accounts are mismatched, which can lead to unintended elevation of permissions.
To remove inactive user accounts:
Now you must configure both Automation Suite and your identity provider (IdP) for the integration.
Automation Suite can connect to any third-party identity provider (IdP) that uses the SAML 2.0 standard.
While configuration may vary depending on your chosen IdP, we have validated the configuration for the following providers, which you can use as reference to configure the integration:
-
Okta
-
PingOne
For other identity providers, we recommend that you follow their integration documentation.
Sample configuration for Okta
- In a different browser tab, log in to the Okta Admin Console.
- Go to Applications > Applications, click Create App Integration, and select SAML 2.0 as the sign-on method.
- In the General Settings page, specify a name for the app you are integrating with, namely Automation Suite.
- On the Configure SAML page, fill in the General section as follows:
-
Single sign-on URL: Enter the Assertion Consumer Service URL value you got from Automation Suite.
-
Select the Use this for Recipient URL and Destination URL checkbox.
-
Audience URI: Enter the Entity ID value you got from Automation Suite.
-
Name ID Format: Select EmailAddress
-
Application Username: Select Email
-
- For Attribute Statements, add the following:
-
Name:
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
-
Leave the Name Format as Unspecified.
-
Set Value to
user.email
, or the user attribute that contains the user's unique email address -
Optionally add other attribute mappings. Automation Suite also supports the First Name, Last Name, Job Title, and Department user attributes. This information is then propagated to Automation Suite, where it can be made available to other services, such as Automation Hub.
-
- On the Feedback page, select the option you prefer.
- Click Finish.
- On the Sign On tab, in the Settings section, under View Setup Instructions, copy the Identity Provider metadata URL value and save it for later.
- On the Application page for Automation Suite, select the newly created application.
- On the Assignments tab, select Assign > Assign to People, and then select the users that you want to allow to use SAML authentication for Automation Suite.The newly added users are displayed on the People tab.
Sample configuration for PingOne
- In a different browser tab, log in to the Okta Admin Console.
- Go to Applications > Applications, click Create App Integration, and select SAML 2.0 as the sign-on method.
- In the General Settings page, specify a name for the app you are integrating with, namely Automation Suite.
- On the Configure SAML page, fill in the General section as follows:
- Single sign-on URL: Enter the Assertion Consumer Service URL value you got from Automation Suite.
- Select the Use this for Recipient URL and Destination URL checkbox.
- Audience URI: Enter the Entity ID value you got from Automation Suite.
- Name ID Format: Select EmailAddress.
- Application Username: Select Email
- For Attribute Statements, add the following:
- Name:
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
- Leave the Name Format as Unspecified.
- Set Value to
user.email
, or the user attribute that contains the user's unique email addressd. - Optionally add other attribute mappings. Automation Suite also supports the First Name, Last Name, Job Title, and Department user attributes. This information is then propagated to Automation Suite, where it can be made available to other services, such as Automation Hub.
- Name:
- On the Feedback page, select the option you prefer.
- Click Finish.
- On the Sign On tab, in the Settings section, under View Setup Instructions, copy the Identity Provider metadata URL value and save it for later.
- On the Application page for Automation Suite, select the newly created application.
- On the Assignments tab, select Assign > Assign to People, and then select the users that you want to allow to use SAML authentication for Automation Suite. The newly added users are displayed on the People tab.
To enable Automation Suite as a service provider that recognizes your identity provider, complete the steps below:
To validate the SAML SSO integration is working properly, check that the integration is running:
- Open an incognito browser window.
- Navigate to your Automation Suite organization-specific URL.
- Check the following:
-
Are you prompted to sign in with your SAML identity provider?
-
Are you able to successfully sign in?
-
If you are signing in with an email address that matches an existing user account, do you have the appropriate permissions?
-
Administrators can set up just-in-time provisioning rules that automatically add users to an existing UiPath group using the attribute name/value pairs given by the IdP via sign in. By leveraging groups, users are automatically provisioned with the right licenses and roles when they sign in.
Just-in-time provisioning rules are evaluated when a user signs in. If the user account meets the conditions for a rule, it is automatically added to the local group associated with the rule.
group
, Relationship=is
, Value=Automation User
.
Phase 1. Set up provisioning groups
Adding an account to a group means the account inherits the licenses, roles, and robot configuration defined for the group, if any.
So if you set up a group with a particular type of user in mind (for example, your employees who create the automations, or your employees who test the automations), you can onboard a new employee of that type by simply setting up their account in the IdP in the same way as other similar accounts.
This way, you set up the group once, and then replicate the setup by adding accounts to the group when needed. Also, if the setup for a particular group of users needs to change, you only need to update the group once and the changes apply for all accounts in the group.
To set up a group for a provisioning rule:
-
If you want, you can use one of your existing groups instead of creating a new one.
-
(Optional and requires user license management) If users in this group need user licenses, set up license allocation rules for the group.
If you are using an existing group, check license allocation for the group to make sure the right licenses are being allocated. If not, either change allocations, or consider creating a new group.
-
Assign tenant roles and optionally complete robot setup for the group. See Assigning roles to a group.
If you are using an existing group, check the roles currently assigned to the group to make sure they are adequate for the type of users you will add to the group. If not, either edit the roles assigned to this group, or consider creating a new group.
-
Add the group to folders and assign folder roles, as needed. See Managing folder access.
Now you can use this group in a provisioning rule.
Phase 2. Create a provisioning rule for a group
Ensure the claim associated with the SAML provisioning rule is sent to the SAML payload by configuring it in the SAML application.
After the SAML integration is configured and after you have set up a group:
- Go to Admin > Security Settings > Authentication Settings.
-
Under the SAML SSO option, click View Provisioning Rules:
The SAML SSO Provisioning Rules page opens, where your existing rules are listed.
-
In the top right corner of the page, click Add rule.
The Add new rule page opens.
- Under Basic details, fill in the Rule Name field and optionally fill in the Description field.
-
Under Conditions, click Add rule.
A row of fields for a new condition is added. Together, they define the criteria that an account must meet at sign in to be added to a group (chosen later).
- In the Claim field, type the name of the claim, as it appears in the IdP.
-
From the Relationship list, select how the claim relates to the value. The following options are available:
Relationship
Condition requirement
Example
is
exact match, case sensitive
Department is RPA
requires that the value for theDepartment
claim beRPA
.The condition is not met if the value isRPADev
, for example.This relationship works for multi-valued claims.
For example, ifadministrator
anddeveloper
values are sent under theGroup
claim, thenGroup is administrator
would be a valid relationship.is not
anything except specified value, case sensitive
ForDepartment is not ctr
, any account is added to the group unlessDepartment
has the valuectr
.The condition is met if the department isCtr
orelectr
.contains
includes, does not require an exact match, case sensitive
Department contains RPA
requires that the value for theDepartment
claim includeRPA
.The condition is met if the value isRPADev
,xRPAx
, orNewRPA
, for example.not contains
excludes, does not require an exact match, case sensitive
ForDepartment not contains ctr
, any account is added to the group unless theDepartment
value includesctr
.Accounts for which the department isctr
orelectr
, for example, are not added to the group.is case insensitive
exact match, not case sensitive
Department is case insensitive RPA
requires that the value for theDepartment
claim berpa
, in any capitalization.The condition is met if the value isrpa
, for example. The condition is not met if the value iscrpa
.contains case insensitive
includes, does not require an exact match, not case sensitive
Department contains case insensitive RPA
requires that the value for theDepartment
claim includeRPA
, in any capitalization.The condition is met if the value isrpa
,cRPA
, orrpA
, for example. - In the Value field, type the value that is needed to meet the condition.
-
If you want to add another condition, click Add rule to add a new condition row.
When you add multiple conditions, all conditions must be met for the provisioning rule to apply. For example, if you define the rulesDepartment is RPA
andTitle is Engineer
, only users that are both in the RPA department and have the title Engineer are added to the specified groups. An account for which the department is RPA, but the title is QA is not added to the groups. -
Under Assign to groups, in the Add Groups box, start typing the name of a group and then select a group from the list of results. Repeat to add more groups, if needed.
When the conditions are met, accounts are automatically added to these groups when they login.
- Click Save in the bottom right corner to add the rule.
With a rule in place, whenever a user logs in and their account meets the conditions specified for a rule, their account is added to the provisioning groups attached to the rule, and their account is set up to work.
After permissions have been configured, we recommend that you ask all your existing users to sign out of their UiPath account and sign in using SAML SSO.
To sign in to Studio and Assistant using SAML SSO, users must configure Assistant as follows:
This is only required for new users who have not used Automation Suite before and therefore did not have a local account set up for them in Automation Suite when the integration was enabled.
You can add new users to Automation Suite groups by their email address (as used in the external IdP). Once a user has been assigned to a group or they have signed in, they will be available through search for role assignment across all Automation Suite services.
After all users have transitioned to SAML SSO and new users are set up, we recommend that you remove all local user accounts that are not administrator accounts. This ensures that users can no longer sign in with their local account credentials and they have to sign in with SAML SSO.
In case of problems with the SAML integration (such as updating an expired certificate), or if you want to switch to a different authentication option, a local user account with the administrator role is recommended.
User login failed. (#216)
, it may be due to missing email address mapping in the configuration of the SAML identity provider.
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
(case sensitive) and the value must have a valid email address.
- Overview of the Configuration Process
- Known limitations
- Cannot search accounts from your identity provider
- Cannot see directory users at the organization level
- Incorrect ACS URL in the SAML configuration UI
- Prerequisites
- Step 1. Clean up Inactive User Accounts
- Step 2. Configure the SAML Integration
- Step 2.1. Obtain SAML Service Provider Details
- Step 2.2. Configure Your Identity Provider
- Step 2.3. Configure Automation Suite
- Step 2.4. Check That the Integration Is Running
- Step 2.5. Configure Provisioning Rules (optional)
- Step 3. Transition Your Users to SAML SSO
- Step. 4. Configure Permissions and Robots
- Step 5. Discontinue Use of Local User Accounts (optional)
- Troubleshooting