配置 SAML 集成

通过在 Automation Suite 中使用 SAML 配置，我们增强了身份验证的安全性和效率。我们的系统使用 SAML 通过安全访问令牌启用单点登录 (SSO)，从而允许 UiPath 平台与使用 SAML 2.0 标准的任何身份提供程序 (IdP) 连接。

此外，我们的 SAML 配置包括单点注销 (SLO) 功能，可实现在 IdP 下统一的所有应用程序上同时注销。

SAML 集成经精心设计，您可以逐步实施，而不会影响现有用户。

备注：

从原生 Microsoft Entra ID 集成切换到 SAML 集成

如果您使用 Microsoft Entra ID 进行身份验证，我们建议使用我们的原生 Microsoft Entra ID 集成，因为它的功能更丰富。

如果您确实决定切换到 SAML 集成，则必须将通过目录组完成的角色分配手动替换为对目录帐户的直接角色分配，这样您就不必完全重新创建访问架构。

已知限制

• 不支持来自身份提供程序的加密 SAML 断言。
• 您无法从身份提供程序中搜索用户和组。 只有已配置的目录用户可用于搜索。
• 您无法在组织级别查看目录用户。只有本地用户会出现在组织级别。即时配置会添加目录用户，因此这些用户不会显示在 Automation Suite 的“帐户和组”页面上。

先决条件

要设置 SAML 集成，您需要满足以下条件：

• Automation Suite 组织和第三方身份提供程序中的管理员权限。如果您在身份提供程序中没有管理员权限，则可以与管理员合作完成设置流程。
• 推荐使用 UiPath™ Studio 和 UiPath Assistant 2020.10.3 或更高版本，以便您可以将其设置为使用推荐的部署。

步骤 1. 清理非活动用户帐户

如果您的组织回收电子邮件地址，则在配置 SAML 集成之前请务必删除所有非活动的用户帐户。

启用集成时，Automation Suite 中的本地帐户可以与使用相同电子邮件地址的外部身份提供程序中的目录帐户相关联。当目录帐户用户首次使用该电子邮件地址登录时，会与该帐户关联。身份提供程序的身份将从本地帐户继承所有角色，以便无缝转换。因此，如果 Automation Suite 中存在非活动本地帐户，则存在本地帐户和目录帐户不匹配的风险，这可能会导致权限意外得到提升。

要删除非活动的用户帐户，请执行以下操作：

1. 以组织管理员身份登录 Automation Suite。

2. 转到“管理员” ，选择您的组织，然后选择“帐户和组” 。组织的“帐户和组”页面将在“用户”选项卡上打开。

3. 选择“上次活跃”列的列标题，以对用户重新排序，以便上次登录日期最早的用户显示在顶部。“上次活动”列显示用户的上次登录日期。在此列中处于待处理状态表示用户从未登录。

4. 选择行末尾的“删除”图标，以删除该用户的本地帐户。

   

5. 在确认对话框中，选择“删除”以确认从 Automation Suite 中删除帐户。用户帐户将从页面中删除。

6. 继续删除组织中所有非活动的用户帐户。

步骤 2. 配置 SAML 集成

现在，您必须为集成配置 Automation Suite 和身份提供程序 (IdP)。

步骤 2.1.获取 SAML 服务提供程序详细信息

1. 以组织管理员身份登录 Automation Suite。

2. 转到“管理员” ，选择您的组织，然后选择“安全” 。组织的“安全设置”页面将在“身份验证设置”选项卡上打开。

3. 在“SSO 的目录配置”下，选择“配置 SSO” 。系统将打开“SSO 配置”窗口，其中描述了集成的优势和先决条件。

4. 从两个 SSO 选项中，选择“SAML 2.0” ，以配置与 IdP 的集成。系统将打开“SAML 集成的优势”页面，该页面简要概述了使用集成的优势以及先决条件。

5. 选择“下一步”以继续集成。“SAML SSO”页面将在“常规详细信息”选项卡上打开。

6. 在页面的顶部，您可以找到配置身份提供程序所需的 UiPath 信息：断言使用者服务 URL ，实体 ID 。复制并保存它们，以便配置身份提供程序。

   

7. The entity ID contains the organization ID by default. You can change the format to use the global identifier (no organization ID) by using the Entity ID format option. Select Org specific identifier to use the format containing the organization id, or Global identifier to use the format that does not contain the organizaiton id. We recommend using the organization specific identifier, because it allows you to enroll multiple UiPath organizations in your identity provider, if you ever want to.

随时开启浏览器标签页以备后用。

步骤 2.2.配置您的身份提供程序

您可以连接到使用 SAML 2.0 标准的任何第三方身份提供程序 (IdP)。 虽然配置可能因您选择的 IdP 而异，但我们已经验证了使用 Okta 或 PingOne 的配置，您可以将其用作配置集成的参考。

将Okta设置为您的身份提供程序。

将 PingOne 设置为您的身份提供程序。

对于其他身份提供程序，我们建议您遵循其集成文档。

步骤 2.3。 配置 Automation Suite

To enable Automation Suite as a service provider that recognizes your identity provider, follow the below steps:

1. 返回到 Automation Suite 中的“SAML SSO 配置”选项卡。

2. In the second section of the General details page, you can see the fields necessary to configure the identity provider in Automation Suite. In the Metadata URL field, enter the metadata URL of your identity provider. This enables Automation Suite to regularly fetch and update data from your identity provider, streamlining the SAML configuration process for the long term.

   重要提示：

   我们强烈建议在 SAML 配置期间使用元数据 URL 。这使 UiPath 能够定期从您的身份提供程序获取和更新数据，从长远来看，从而简化了 SAML 配置流程。

   

3. 选择“获取数据”（名称） 。完成后，系统将在登录 URL 、身份提供程序实体 ID和签名证书字段中填充 IdP 信息。

4. 即使这不是推荐的方法，您也可以选择在“登录 URL” 、 “身份提供程序实体 ID”和“签名证书”字段上手动输入身份提供程序的 SAML 详细信息。

5. 要手动输入多个证书，请以 Base64 编码将这些证书粘贴到“签名证书”字段中，并用开始和结束证书指示符括起并用换行符分隔。例如，如果有两个证书，则应使用以下格式：

   -----BEGIN CERTIFICATE-----
   <base64 encoded certificate retrieved from SAML metadata URL or SAML admin>
   -----END CERTIFICATE-----
   -----BEGIN CERTIFICATE-----
   <base64 encoded certificate retrieved from SAML metadata URL or SAML admin>
   -----END CERTIFICATE-----
   

   

6. 选择右下角的“下一步”以转到下一步。系统将打开“配置设置”选项卡。映射属性（称为“声明”）将您的身份提供程序和 Automation Suite 之间的用户详细信息相关联。这可确保电子邮件或用户名等用户数据在两个系统中匹配。

   

7. 默认情况下，电子邮件地址用作用户的标识符。 请执行以下步骤：

   1. 在“允许的域”部分中填写要允许用户登录的域。输入由经配置的身份提供程序支持的所有域。使用逗号分隔多个域。
   2. Select the checkbox for I understand and accept existing users and SAML users with matching email addresses will have their accounts linked to acknoweldge users are linked based on their email addresses.
   3. 在“属性映射”下，使用 IdP 中要在 Automation Suite 中显示为用户名称的属性填写“显示名称”字段。您可以在此处使用“名字”和“姓氏”属性。
   4. （可选）通过指定身份提供程序的相应声明和 Automation Suite 中的相应属性，添加新映射。

8. 设置属性后，单击“高级详细信息”选项卡上的“下一步”以配置高级详细信息。

   1. 允许未经请求的身份验证响应：如果您希望能够从 IdP 仪表板导航到 Automation Suite，则启用此选项。
   2. SAML 绑定类型：选择 SAML 配置应如何通过 HTTP 用户代理进行通信。选择“HTTP 重定向”以使用 URL 参数，或选择 HTTP POST 以使用具有 Base64 编码内容的 HTML 表单。
   3. 服务证书用法：选择服务证书的用途： “签名和加密” 、 “加密” 、 “签名” 。证书及其目标在 UiPath SAML 元数据文档中发布。

9. 单击“测试并保存”以完成集成配置。

步骤 2.4.检查集成是否正在运行

要验证 SAML SSO 集成是否正常运行，请执行以下操作：

1. 打开一个隐身浏览器窗口。
2. 导航到您的 Automation Suite 组织 URL。
3. 检查以下内容：
   1. 系统是否会提示您使用 SAML 身份提供程序登录？
   2. 您能否成功登录？
   3. 如果您使用与现有用户帐户匹配的电子邮件地址登录，您是否拥有适当的权限？

步骤 2.5.配置配置规则（可选）

如果您在 IdP 中使用声明，则可以在配置规则中将其用作条件，以便在用户登录 Automation Suite 时自动为其配置正确的许可证和角色。当用户登录时，系统将评估配置规则。如果用户帐户符合规则的条件，系统会自动将其添加到与该规则关联的本地 UiPath 组中。例如，管理员可以使用以下设置配置规则，以将用户直接配置到 Automation Users 组中：声明=组、关系=是、值= Automation User 。

2.5.1 设置配置组

在 Automation Suite 中，向组添加帐户意味着该帐户将继承为该组定义的许可证、角色和机器人配置（如有）。

通过对相似的帐户类型（例如 Developer 或 Tester）进行分组，您可以简化 Automation Suite 的用户入门流程。只需确保在 IdP 中以相同的方式设置类似的帐户即可。

这样，您只需设置一次组，然后在需要时通过向组添加帐户来复制设置即可。 如果需要更改特定帐户组的设置，则只需更新一次该组，这些更改便会应用于该组中的所有帐户。

要为配置规则设置组：

1. in Automation Suite.

   如有需要，您可以使用其中一个现有组，而不必创建新组。

2. (Optional and requires user license management enabled) If accounts 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.

3. Assign tenant roles and optionally complete robot setup for the group. For instructions, refer to 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 account you will add to the group. If not, either edit the roles assigned to this group, or consider creating a new group.

4. 根据需要将组添加到文件夹中并分配文件夹角色。有关说明，请参阅管理文件夹访问权限。

现在，您可以在配置规则中使用此组。

2.5.2. 为组创建配置规则

备注：

通过在 SAML 应用程序中进行配置，确保将与 SAML 配置规则关联的声明发送到 SAML 有效负载。

配置 SAML 集成并设置组后：

1. 转到“管理员”，选择您的组织，然后选择“安全”。

   组织的“安全设置”页面将在“身份验证设置”选项卡上打开。

2. 在“SAML SSO”选项下，选择“查看配置规则” 。系统将打开“SAML SSO 配置规则”页面，其中列出了现有规则。

3. In the top right corner of the page, select Add rule.

   系统将打开“添加新规则”页面。

4. 在“基本详细信息”下，填写“规则名称”字段，并填写“说明”字段（可选）。

5. Under Conditions, select Add rule.

   系统会为新条件添加一行字段。它们共同定义帐户在登录时必须满足的条件，才能被添加到稍后选择的组中。

   

6. 在“声明”字段中，输入 IdP 中显示的声明名称。该字段区分大小写。

7. 从“关系”列表中，选择声明与值的关系。如下表中所述，可以使用以下选项：

   关系	条件要求	示例
   是	精确匹配，区分大小写	Department is RPA 要求 Department 声明的值为 RPA。 例如，如果值为 RPADev，则不满足条件。 此关系适用于多值声明。 例如，如果在 Group 声明下发送值 administrator 和 developer，则 Group is administrator 将是有效关系。
   非	除指定值外的任何内容，区分大小写	对于 Department is not ctr，任何帐户都将添加到组中，除非 Department 的值为 ctr。 如果部门为 Ctr 或 electr，则满足条件。
   包含	包括，不需要精确匹配，区分大小写	Department contains RPA 要求 Department 声明的值包括 RPA。 例如，如果值为 RPADev、xRPAx 或 NewRPA，则满足条件。
   不包含	排除，不需要精确匹配，区分大小写	对于 Department not contains ctr，任何帐户都将添加到组中，除非 Department 值包含 ctr。 例如，部门为 ctr 或 electr 的帐户不会被添加到组中。
   不区分大小写	精确匹配，不区分大小写	Department is case insensitive RPA 要求 Department 声明的值为 rpa（任意大写形式）。 例如，如果值为 rpa，则满足条件。如果值为 crpa，则不满足条件。
   不区分大小写	包含，不需要精确匹配，不区分大小写	Department contains case insensitive RPA 要求 Department 声明的值包括 RPA（任意大写）。 例如，如果值为 rpa、cRPA 或 rpA，则满足条件。

8. 在“值”字段中，输入满足条件所需的值。

9. 如果要添加另一个条件，请选择“添加规则”以添加新的条件行。

   添加多个条件时，必须满足所有条件才能应用配置规则。例如，如果您定义了 Department is RPA 和 Title is Engineer 规则，则只有同时属于 RPA 部门且具有职位名称为“工程师”的用户才会被添加到指定的组中。部门为 RPA、但职位名称为 QA 的帐户不会被添加到组中。

10. 在“分配给组”下的“添加组”框中，开始输入组名，然后从结果列表中选择一个组。如有需要，重复此操作，添加更多组。

    若满足条件，帐户会在登录时自动添加到这些组中。

11. 选择右下角的“保存”以添加规则。

规则设置好后，每当用户登录并且其帐户满足为规则指定的条件时，系统均会将其帐户添加到附加至规则的配置组中，还会将其账户设置为在 Automation Suite 中使用。

示例 SAML 有效负载片段

<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>

SAML 属性映射

在配置 SAML 目录集成时，组织管理员可以定义应将其 IdP 中的哪些属性映射到系统用户属性。 然后，当用户通过 SAML 目录集成登录时，系统会读取传递到 ACS 有效负载中的声明，并将值映射到其对应的系统属性。

备注：

• 必须将 IdP 配置为在 ACS 负载中传递这些声明。
• 确保 IdP 中配置的属性名称与组织管理员门户中的属性映射设置匹配。

例如，如果这是 IdP 中的用户结构，则组织管理员可以设置以下属性映射设置，以便在系统用户对象中填充此信息。

{
    "displayname": "John Doe",
    "fname": "John",
    "lname": "Doe",
    "jobtitle": "Hardware Engineer",
    "dpt": "Engineering",
    "city": "Phoenix"
}

当此组织中的用户通过 SAML 目录集成登录时，其用户对象会更新，以反映此设置。

{
    "Display Name": "John Doe",
    "First Name": "John",
    "Last Name": "Doe",
    "Job Title": "Hardware Engineer",
    "Department": "Engineering",
    "City": "Phoenix"
}

步骤 3. 让您的用户转用 SAML SSO 登录

确保提供 Automation Suite 组织特定于组织的 URL。

备注：

切换到 SAML 集成后，Microsoft Entra ID 集成将被禁用。Microsoft Entra ID 组分配不再适用，因此 Automation Suite 组成员身份和从 Microsoft Entra ID 继承的权限不再适用。

要使用 SAML SSO 登录 Automation Suite，用户可以：

• 导航到特定于组织的 URL。URL 必须包含组织 ID，并以正斜杠结尾，例如 https://{yourDomain}/orgID。
• 导航到 https://{yourDomain}，在“登录”页面中选择“使用 SSO 登录” ，然后提供其特定于组织的 URL。

要使用 SAML SSO 登录 UiPath Studio 和 UiPath Assistant，用户必须按如下方式配置 Assistant：

1. 在 Assistant 中，打开“首选项”，然后选择“Orchestrator 连接”选项卡。

2. 选择“注销” 。

3. 对于连接类型，请选择“服务 URL”。

4. 在“服务 URL”字段中，添加特定于组织的 URL。

   URL 必须包含组织 ID，并以正斜杠结尾，例如 https://{yourDomain}/orgID。否则，连接将失败，失败即表明用户不属于任何组织。

5. 使用 SAML SSO 重新登录。

步骤 4. 配置权限和机器人

只有以前未使用过 Automation Suite 的新用户才需要这样做，因此在启用集成时没有在 Automation Suite 中为他们设置本地帐户。

您可以通过电子邮件地址（在外部 IdP 中使用）将新用户添加到 Automation Suite 组。将用户分配到组或登录后，即可通过在所有 UiPath 服务中搜索角色分配来访问组。

步骤 5. 停止使用本地帐户（可选）

警告：

Make sure all users have signed in with their SSO account at least once before you remove their local accounts. Account linking only occurs at the first SSO sign-in. If a local account is deleted before the user signs in via SSO, a new directory identity is created instead - the user loses access to their previous work, including projects and solutions. This cannot be reversed.

在所有用户都已转用 SAML SSO 登录且新用户已设置完成后，我们建议您移除所有非管理员帐户的本地用户帐户。这可确保用户无法再使用其本地帐户凭据登录，而必须使用 SAML SSO 登录。

您可以根据图标识别本地用户帐户。

本地帐户在以下情况下可能很有用：

• 要管理 SAML 集成问题（例如，更新过期的证书）或更改身份验证设置，建议使用具有组织管理员角色的帐户。

故障排除

如果您收到错误 User login failed. (#216)，则可能是由于 SAML 身份提供程序配置中缺少电子邮件地址映射。

SAML 声明必须命名为http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress （区分大小写），并且该值必须具有有效的电子邮件地址。