- Overview
- Data security and compliance
- Organizations
- Tenants
- Licensing
- Accounts and roles
- External applications
- Logging
- Notifications
- Migrating to cloud
Configuring the SAML integration
This feature is only available if you are on the Enterprise licensing plan.
You can connect Automation Cloud 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 directory 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.
Viewing API access information, which allows you to authorize API requests using a user key, is not available for directory users that sign in through the SAML integration.
To set up the SAML integration, you need:
- An Automation Cloud organization with the Enterprise licensing plan.
-
Administrator permissions in both Automation Cloud 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 the Azure Active Directory integration
If you are currently using the Azure Active Directory integration 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 Cloud 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 Cloud, 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 Cloud and your identity provider (IdP) for the integration.
Automation Cloud 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 using either Okta or PingOnes, which you can use as reference to configure the integration.
For other identity providers, we recommend that you follow their integration documentation.
A. 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 Cloud.
- 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 Cloud.
- Select the Use this for Recipient URL and Destination URL checkbox.
- Audience URI: Enter the Entity ID value you got from Automation Cloud.
- 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 Cloud also supports the First Name, Last Name, Job Title, and Department user attributes. This information is then propagated to Automation Cloud, 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 Cloud, 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 Cloud.
The newly added users are displayed on the People tab.
B. Sample configuration for PingOne
- In a different browser tab, log in to the Ping One Admin Console.
- Go to Connections > Applications, and click the plus icon +.
- Click Web App, and for SAML click Configure.
- On the Create App Profile page, specify a name for your Automation Cloud app.
-
On the Configure SAML Connection page, select Manually Enter and provide the following details:
- ACS URLs: Enter the Assertion Consumer Service URL value you got from Automation Cloud.
- Entity ID: Enter the Entity ID value you got from Automation Cloud.
- SLO binding:HTTP Redirect
- Assertion Validity Duration: Enter the number of seconds for the validity period.
- Click Save and Continue.
- On the Map Attributes page, add the email address:
- Select + Add Attribute.
- For Application Attribute, enter
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
. - Set Outgoing Value to Email Address, or the user attribute that contains the user's unique email address.
- Select the Required checkbox.
- Optionally add other attribute mappings. Automation Cloud also supports the First Name, Last Name, Job Title, and Department user attributes. The attributes are case sensitive. This information is then propagated to Automation Cloud, where it can be made available to other services, such as Automation Hub.
- Click Save and Close.
- Click the toggle for the Automation Cloud app to enable the application for user access.
- On the Configuration tab, copy and save the IdP Metadata URL value for later use.
To enable Automation Cloud as a service provider that recognizes your identity provider, follow the below steps:
To validate the SAML SSO integration is working properly:
- Open up an incognito browser window.
- Navigate to your Automation Cloud 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?
If you use claims in your IdP, you can leverage them as conditions in a provisioning rule so that users are automatically provisioned with the right licenses and roles when they sign in to Automation Cloud.
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 group associated with the rule.
Phase 1. Set up provisioning groups
In Automation Cloud, 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 to Automation Cloud 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:
-
Create a new local group in Automation Cloud.
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. For instructions, 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. For instructions, 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, select your organization, and then select Security.
The Security Settings page for the organization opens on the Authentication Settings tab.
-
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. The
field is case-sensitive.
-
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 to Automation Cloud 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 in Automation Cloud.
Sample SAML payload fragment
<Attribute
Name="groups">
<AttributeValue
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="xs:string">ProcessAutomation-Developer</AttributeValue>
<Attribute
Name="groups">
<AttributeValue
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="xs:string">ProcessAutomation-Developer</AttributeValue>
When configuring the SAML directory integration, org admins have the ability to define which attributes from their IdP should be mapped to the system user attributes. Afterwards, when a user logs in via the SAML directory integration, the system will read the claims that are passed into the ACS payload and map the value to their correspondent system attributes.
For example, if this is the user structure in your IdP, an org administrator can set up the following attribute mapping settings to have this information populated in the system user object.
{
"displayname": "John Doe",
"fname": "John",
"lname": "Doe",
"jobtitle": "Hardware Engineer",
"dpt": "Engineering",
"city": "Phoenix"
}
{
"displayname": "John Doe",
"fname": "John",
"lname": "Doe",
"jobtitle": "Hardware Engineer",
"dpt": "Engineering",
"city": "Phoenix"
}
When a user in this organization logs in via the SAML directory integration, their user object will be updated to reflect this setting.
{
"Display Name": "John Doe",
"First Name": "John",
"Last Name": "Doe",
"Job Title": "Hardware Engineer",
"Department": "Engineering",
"City": "Phoenix"
}
{
"Display Name": "John Doe",
"First Name": "John",
"Last Name": "Doe",
"Job Title": "Hardware Engineer",
"Department": "Engineering",
"City": "Phoenix"
}
-
Your IdP must be configured to pass in these claims in the ACS payload.
-
Ensure the attribute names configured in the IdP match the attribute mapping settings in the org administrator portal.
Make sure you provide your organization-specific URL for Automation Cloud to all your users and follow the instructions below. Only organization administrators can see the organization URL in Organization Settings.
To sign in to Automation Cloud with SAML SSO, users can:
- navigate to your organization-specific URL. The URL must include the organization ID and end in a forward slash, such as
https://cloud.uipath.com/orgID/
. - navigate to https://cloud.uipath.com, select Continue with SSO on the Login page, then provide their organization-specific URL.
After switching to the SAML integration, the Azure AD integration is disabled. Azure AD group assignments no longer apply, so Automation Cloud group membership and the permissions inherited from Azure AD are no longer respected.
To sign in to UiPath Studio and UiPath Assistant using SAML SSO, users must configure Assistant as follows:
This is only required for new users who have not used Automation Cloud before and therefore did not have a local account set up for them in Automation Cloud when the integration was enabled.
You can add new users to Automation Cloud 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 Cloud 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.
You can identify local user accounts based on the user icons.
Managing Authentication Settings in Automation Cloud
In case of problems with the SAML integration (such as updating an expired certificate), or if you want to switch to a different authentication setting, a local user account with the organization administrator role is recommended.
API Access
If you have processes in place that rely on the information obtained by clicking API Access (Admin > Tenants page) to make API calls to a service, you need a UiPath account because the button is not available when logged in with a SAML SSO account. Alternatively, you can switch to using OAuth for authorization, in which case the information from API Access is no longer required.
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
and the value must have a valid email address.
You can use the Azure portal to enable SSO for an Enterprise application that you added to your Azure AD tenant.
After you configure SSO, your users can sign in by using their Azure AD credentials.
If your users are in Azure AD but cannot use the Azure AD integration instructions to configure AAD to your UiPath organization, configuring AAD as a SAML-based IdP may be an option.
This is due to restrictions around giving permissions to read user details and group memberships of all UiPath application users.
-
Log into the Azure portal using one of the roles listed in the prerequisites.
-
Go to Azure AD, then select Enterprise applications.
The All applications page opens that lists the applications in your Azure AD tenant.
Search for and then select the application that you want to use. For example, UiPath.
Note:To create an application for SSO, follow the steps in this section.
-
From the left sidebar in the Manage section, select Single sign-on to open the SSO editing page.
-
Select SAML to open the SSO configuration page.
After the application has been configured, users can sign into it using their Azure AD tenant credentials.
-
Under the Basic SAML Configuration section, click Edit.
-
Fill out the Entity ID and Assertion Consumer Service (ACS) URL fields based on the values provided in the SAML configuration settings in the UiPath portal.
-
Click Save.
Note:UiPath requires either the http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress or the http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn claims to be sent by the SAML identity provider.
If both claims are sent in the ACS payload, then UiPath will prioritize the http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress claim.
By default, the application in Azure AD is configured to send the http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress claim, with the user's email address as the value for the claim.
If you are switching from or planning to switch to Azure AD directory integration, please note:
-
The value passed in the prioritized claim is used by UiPath as a unique identifier and is used to link any existing local users (using the local user's email address) to this directory user in Azure AD.
-
For a smooth switch between Azure AD and SAML directory integration, it is recommended you pass in both of these claims with the appropriate user values.
Here is an example configuration:
-
-
Copy the App Federation Metadata Url.
-
Navigate to the UiPath Administration portal and go to the SAML Configuration page.
-
Paste the App Federation Metadata Url in the Metadata URL field.
-
Click Fetch data to have the system request user-related info from the identity provider.
-
Log into the Azure portal using one of the roles listed in the prerequisites.
-
Go to Azure AD, then select Enterprise applications.
The All applications page opens that lists the applications in your Azure AD tenant.
Search for and then select the application that you want to use. For example, UiPath.
Note:To create an application for SSO, follow the steps in this section.
-
From the left sidebar in the Manage section, select Single sign-on to open the SSO editing page.
-
Click Edit in the Attributes & Claims section of the SSO editing page.
-
Click Add a group claim to configure the groups that you want to send to UiPath.
Note:To set advanced configurations, choose from the Advanced Settings dropdown.
-
Click Save.
-
To finish the configuration, follow the Step 2.5 Configure Provisioning Rules (optional) steps from our public documentation.
If a customer prefers to use UPN, you can navigate to the Attributes & Claims section and change the value for the emailaddress attribute.
- Log into the Azure portal using one of the roles listed in the prerequisites.
- Go to Azure AD, then select Enterprise applications.The All applications page opens that lists the applications in your Azure AD tenant.
- click New Application > Create your own application.
- Give your application a name. For example, UiPath.
- Select Integrate any other application that you don't find in the gallery (Non-gallery).
- Click Create.
- Overview of the configuration process
- Known limitations
- Cannot search accounts from your identity provider
- Cannot see directory users at the organization level
- Cannot view API access information
- 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 Cloud
- Step 2.4. Check that the integration is running
- Step 2.5. Configure provisioning rules (optional)
- SAML Attribute mapping
- Step 3. Transition your users to SAML SSO
- Step 4. Configure permissions and robots
- Step 5. Discontinue use of local accounts (optional)
- Considerations for discontinuing use of local accounts
- Troubleshooting
- Setting up SAML SSO with Azure AD
- Enabling SAML SSO for an application
- Setting up claims for automatic provisioning to UiPath
- Create application for SSO