配置 SAML 集成

您可以将 Orchestrator 连接到任何使用 SAML 2.0 标准的身份提供程序 (IdP)。本页通过展示一些 SAML 集成配置示例来说明整个流程。

配置流程概述

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

此页面更详细地描述了流程的主要阶段，其中包括：

1. 清理非活动用户帐户
2. 配置 SAML 集成
3. 转换现有用户以使用 SAML SSO 登录
4. 为新用户配置权限和机器人
5. 停止使用本地帐户（可选）

已知限制

• 不支持来自身份提供程序的加密 SAML 断言。

• 您无法从身份提供程序中搜索用户和组。 只有已配置的目录用户可用于搜索。

• “SAML SSO 配置”页面显示的“断言客户服务 URL”不正确。

  解决方法：要解决此问题，请在 IDP 中配置不带分区 ID 的断言客户服务 URL。例如，原始 URL：https://{your-domain}/91483651-d8d6-4673-bd3f-54b0f7dc513a/identity_/Saml2/Acs 将变为 https://{your-domain}/identity_/Saml2/Acs
  备注：

  此解决方法存在两个注意事项：

  • IDP 发起的登录流程将无法按预期工作。

  • 已在 2023.4 中修复此问题。升级到 2023.4 及以上版本后，您需要更改“断言客户服务 URL”，以包含分区 ID。

先决条件

要设置 SAML 集成，您需要：

• Orchestrator 和第三方身份提供程序中的管理员权限。

  如果您在身份提供程序中没有管理员权限，则可以与管理员合作完成设置流程。

• 推荐使用 UiPath™ Studio 和 UiPath Assistant 2020.10.3 或更高版本，以便您可以将其设置为使用推荐的部署。

  备注：

  如果您当前使用的是 Azure Active Directory 集成进行身份验证，我们建议您继续使用 AAD 集成，因为其功能更丰富。

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

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

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

启用集成时，Orchestrator 中的本地帐户可以与使用相同电子邮件地址的外部身份提供程序中的目录帐户相关联。当目录帐户用户首次使用该电子邮件地址登录时，会与该帐户关联。身份提供程序的身份将继承本地帐户具有的任何角色，以便无缝转换。

因此，如果 Orchestrator 中存在不活动的本地帐户，则存在本地帐户和目录帐户不匹配的风险，这可能会导致权限意外提升。

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

1. 以管理员身份登录 Orchestrator。
2. 转到“管理员” > “帐户和组” > “用户”选项卡。
3. 单击“上次活跃”列的列标题，以对用户重新排序，以便上次登录日期最早的用户显示在顶部：
   
   

   

   
   

   “上次活动”列显示用户上次登录 Orchestrator 的日期。如果您在此列中看到“待定”（如上例所示），则这表示用户从未登录。您可以使用此信息来识别不活跃的用户。

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

   

   
   
5. 在确认对话框中，单击“删除”以确认从 Orchestrator 中删除帐户。

   用户帐户将从页面中移除。

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

步骤 2. 配置 SAML 集成

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

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

1. 以管理员身份登录 Orchestrator。
2. 转到“管理” > “安全设置” > “身份验证设置”选项卡。
3. 选择“用户可以使用 SAML SSO 登录”，然后单击“配置”。

   系统将打开信息对话框。

4. 在对话框中，单击“继续”。

   下一页提供集成的概述。

5. 在右下角，单击“下一步”以继续配置。

   在“一般详细信息”步骤中，在“要在 IdP 中配置的数据”下，我们提供配置身份提供程序以连接到 Orchestrator 所需的信息。

   
   

   

   
   
6. 复制并保存实体 ID 和断言使用者服务 URL 的值。您在下一步中将需要这些信息。
   重要提示：如果您也在主机级别设置了此集成，请确保使用组织级别的“断言使用者服务 URL”的值，而不是主机中的值。

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

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

Orchestrator 可以连接到使用 SAML 2.0 标准的任何第三方身份提供程序 (IdP)。

虽然配置可能因您选择的 IdP 而异，但我们已验证以下提供程序的配置：

• 奥克塔

• PingOne。

您可以使用下面的配置说明设置与这些提供程序的集成。

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

A. Okta 的示例配置

注意：本节中的说明适用于示例配置。如需此处未涵盖的任何 IdP 设置的更多相关信息，请使用 Okta 文档。

1. 在其他浏览器选项卡中，登录到“Okta 管理控制台”。
2. 转到“应用程序”>“应用程序”，单击“创建应用程序集成” ，然后选择“SAML 2.0”作为登录方法。
3. 在“常规设置”页面中，指定要集成的应用程序名称，即 Orchestrator。
4. 在“配置 SAML”页面上，按照以下内容填写“常规”部分：
   1. 单点登录 URL：输入从 Orchestrator 获取的“断言使用者服务 URL”值。
   2. 选中“将此用于收件人 URL 和目标 URL”复选框。
   3. “受众 URI”：输入从 Orchestrator 获取的“实体 ID”值。
   4. 姓名 ID 格式：选择“电子邮件地址”
   5. 应用程序用户名：选择“电子邮件”
5. 对于属性语句，请添加以下内容：
   1. 名称：http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
   2. 将“名称格式”保留为“未指定”。
   3. 将“值”设置为 user.email 或包含用户唯一电子邮件地址的用户属性。
   4. 添加其他属性映射（可选）。Orchestrator 还支持“名字”、“姓氏”、“职位名称”和“部门”用户属性。然后，此信息将传播到 Orchestrator，供其他服务（例如 Automation Hub）使用。
6. 在“反馈”页面上，选择您偏好的选项。
7. 单击“完成”。
8. 在“登录”选项卡的“设置”部分，在“查看设置说明”下，复制“身份提供程序元数据 URL”值并保存以备后用。
9. 在 Orchestrator 的“应用程序”页面上，选择新创建的应用程序。
10. 在“分配”选项卡上，选择“分配”>“分配给人员”，然后选择允许对 Orchestrator 使用 SAML 身份验证的用户。

新添加的用户将显示在“人员”选项卡上。

B. PingOne 的示例配置

注意：本节中的说明适用于示例配置。如需此处未涵盖的任何 IdP 设置的更多相关信息，请使用 PingOne 文档。

1. 在其他浏览器选项卡中，登录到 PingOne 管理控制台。
2. 转到“连接” > “应用程序”，然后单击加号图标“+”。
3. 单击“网页应用程序”，对于 SAML，单击“配置”。
4. 在“创建应用程序配置文件”页面上，指定 Orchestrator 应用程序的名称。
5. 在“配置 SAML 连接”页面上，选择“手动输入”并提供以下信息：
   • ACS URL：输入从 Orchestrator 获取的断言使用者服务 URL 值。
   • 实体 ID：输入从 Orchestrator 获取的实体 ID 值。
   • SLO 绑定：HTTP 重定向
   • 断言有效期：输入有效期的秒数。
6. 单击“保存并继续”。
7. 在“映射属性”页面上，添加电子邮件地址：
   1. 选择“+ 添加属性”。
   2. 对于“应用程序属性”，请输入 http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress。
   3. 将“传出值”设置为“电子邮件地址”或包含用户的唯一电子邮件地址的用户属性。
   4. 选中“必填项”复选框。
   5. 添加其他属性映射（可选）。Orchestrator 还支持“名字”、“姓氏”、“职位名称”和“部门”用户属性。然后，此信息将传播到 Orchestrator，供其他服务（例如 Automation Hub）使用。
8. 单击“保存并关闭”。
9. 单击 Orchestrator 应用程序的开关，以启用该应用程序以供用户访问。
10. 在“配置”选项卡上，复制并保存“IdP 元数据 URL”值以供之后使用。

步骤 2.3。配置 Orchestrator

要将 Orchestrator 启用为识别您的身份提供程序的服务提供程序，请完成以下步骤：

1. 返回到 Orchestrator 中的“SAML 配置”选项卡。
2. 在“常规详细信息”步骤的“来自 IdP 的数据”下，使用在配置期间获得的元数据 URL 填写“元数据 URL”字段。
3. 单击“获取数据”。

   完成后，系统将在“登录 URL”、“身份提供程序实体 ID”和“签名证书”字段中填充 IdP 信息。

4. 单击右下角的“下一步”以转到下一步。
5. 在“配置设置”的“允许的域”部分中填写您允许用户登录的域。输入由经配置的身份提供程序支持的所有域。

   使用逗号分隔多个域。

6. 选中此复选框，即表示您了解具有匹配电子邮件地址的帐户将被关联。
7. “可选”填写“属性映射”。
8. 如果您还想配置高级详细信息，请单击右下角的“下一步”以进入最后一步。

   否则，请单击“测试并保存”以完成集成配置，并跳过本节中的其余步骤。

9. 在“高级设置”页面上，根据需要配置选项：
   • 允许未经请求的身份验证响应：如果您希望能够从 IdP 仪表板导航到 Orchestrator，请启用。
   • SAML 绑定类型：HTTP 重定向将配置 SAML 配，以便通过 HTTP 用户代理使用 URL 参数进行通信。
   • 服务证书用法：选择您的偏好选项。
10. 单击“测试并保存”以完成集成配置。

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

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

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

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

管理员可以设置即时配置规则，使用 IdP 通过登录提供的属性名称/值对自动将用户添加到现有 UiPath 组。通过利用组，系统会在用户登录时自动为其配置正确的许可证和角色。

系统会在用户登录时评估即时配置规则。如果用户帐户符合规则的条件，系统会自动将其添加到与该规则关联的组中。

例如，管理员可以使用以下设置配置规则，以将用户直接配置到“自动化用户”组中：声明=group、关系=is、值=Automation User。

阶段 1. 设置配置组

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

因此，如果您针对特定类型的用户（例如，创建自动化的员工或测试自动化的员工）设置了一个组，则只需在 IdP 中以对其他类似帐户采取的相同方式进行设置，即可将该类型的新员工加入。

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

要为配置规则设置组：

1. 创建新的本地组。

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

2. （此为可选项，需要用户许可证管理）如果此组中的用户需要用户许可证，请为该组设置许可证分配规则。

   如果您使用的是现有组，请检查该组的许可证分配情况，确保分配的许可证正确无误。如未使用现有组，请更改分配情况，或考虑创建一个新组。

3. 为组分配租户角色，也可以完成机器人设置。请参阅向组分配角色。

   如果您使用的是现有组，请检查当前分配给该组的角色，确保其符合您将添加到该组中的用户类型。如未使用现有组，请编辑分配给该组的角色，或考虑创建一个新组。

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

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

阶段 2. 为组创建配置规则

备注：

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

配置 SAML 集成并设置组后：

1. 转到“管理” > “安全设置” > “身份验证设置”选项卡。

2. 在“SAML SSO”选项下，单击“查看配置规则”：

   
   

   

   
   

   系统将打开“SAML SSO 配置规则”页面，其中列出了现有规则。

3. 在页面右上角，单击“添加规则”。

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

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

5. 在“条件”下，单击“添加规则”。

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

   
   

   

   
   
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. 如果要添加另一个条件，请单击“添加规则”，添加新的条件行。

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

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

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

11. 单击右下角的“保存”，添加规则。

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

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

在您配置权限后，我们建议您要求所有现有用户注销其 UiPath 帐户并使用 SAML SSO 登录。

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

1. 在 Assistant 中，打开“首选项”，然后选择“Orchestrator 连接”选项卡。
2. 单击“注销”。
3. 对于连接类型，请选择“服务 URL”。
4. 在“服务 URL”字段中，添加特定于组织的 URL。
   URL 必须包含组织 ID，并以正斜杠结尾，例如 https://OrchestratorURL/orgID/。否则，连接将失败，失败即表明用户不属于任何组织。
5. 使用 SAML SSO 重新登录。

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

这仅适用于以前未使用过 Orchestrator，因此在启用集成时未在 Orchestrator 中为他们设置本地帐户的新用户。

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

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

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

停止使用本地帐户的注意事项

如果 SAML 集成出现问题（例如更新过期的证书），或者您想切换到其他身份验证选项，建议使用具有管理员角色的本地用户帐户。

故障排除

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

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