管理外部 OAuth 应用程序

作为管理员，使用 OAuth 框架，您可以将授权委派给外部应用程序。注册后，这些应用程序可以对 UiPath 应用程序或您指定的 API 范围内的资源进行 API 调用。

概述

支持的应用程序类型和访问作用域

您可以将应用程序注册为以下类型之一：

• 机密应用程序：可以安全存储注册后生成的应用程序密码的应用程序；例如网页应用程序和服务到服务 (S2S) 应用程序。
• 非机密应用程序：不能保证安全存储应用程序密码的应用程序，因此不会生成应用程序密码；例如桌面或原生移动应用程序。

应用程序类型定义允许用于授权应用程序的授权授予类型。机密应用程序的作用域是用户级别和/或应用程序范围的 API。非机密应用程序只能发送针对用户作用域的请求，这意味着用户必须登录才能授权应用程序的请求。

可用的 UiPath 资源

注册外部应用程序时，您可以通过 UiPath 应用程序的 API 向外部应用程序授予其访问一个或多个 UiPath 资源的权限。

以下 API 可用：

• Orchestrator API
• 平台管理 API

授权外部应用程序需要的三个部分

要让外部应用程序通过 OAuth 访问您的 UiPath 资源，需要执行三个步骤：

步骤	谁	操作	详细信息
1	组织管理员	在 Automation Suite 中注册外部应用程序	注册外部应用程序
2	组织管理员	向开发者提供应用程序注册详细信息	向开发者提供详细信息
2	开发者	设置外部应用程序，使其使用适当的授权类型来访问您的 UiPath 资源	使用外部应用程序访问 UiPath 资源https://docs.uipath.com/zh-CN/automation-suite/automation-suite/2022.10/api-guide/authentication

注册外部应用程序

要注册外部应用程序，使其可以使用 OAuth 访问您的 UiPath 资源，请执行以下操作：

1. 在 Automation Suite 中，转到“管理” > “外部应用程序”，然后单击右上角的“添加应用程序”：

   将打开“添加应用程序”页面，您可以在其中注册外部应用程序。

2. 填写“应用程序名称”字段。
3. 为“应用程序类型”选择一个选项。

   如果您选择“机密应用程序”，您将在应用程序创建结束时收到一个应用程序密码，因此请确保您的应用程序可以安全地存储它。如果无法访问，请选择“非机密应用程序”。

4. 在“资源”下，单击“添加作用域”。

   “编辑资源”面板会在右侧打开，您可以在其中选择应用程序应有权访问的资源。

5. 从“资源”下拉列表中，选择应用程序可以使用的 UiPath API。
   注意：您一次只能为一个资源添加作用域。如果要允许访问多个资源，请重复此过程以为每个资源添加作用域。
6. 在“用户作用域”选项卡上，根据需要选中要授予的逻辑 API 权限的复选框。

   在用户作用域内授予权限意味着外部应用程序可以在用户上下文中访问这些资源，并且具有相应权限的用户必须登录。

7. 如果这是机密应用程序，您可以切换到“应用程序作用域”选项卡，根据需要为所选资源授予应用程序级别的权限。

   借助应用程序作用域下的权限，外部应用程序可以访问选定作用域内应用程序范围内的数据，而无需用户交互。

   非机密应用程序无法访问应用程序作用域。

8. 单击“保存”。

   面板将关闭，选定的资源和范围将添加到表单中的“资源”表中。

9. 如果外部应用程序接受，则可以在“重定向 URL”字段中添加 URL，向其发送授权响应。然后，应用程序可以使用它来访问 UiPath 资源。
10. 单击“添加”以创建注册。

    系统随即会打开一条确认消息。对于机密应用程序，确认消息中包含已注册的外部应用程序可用于请求授权的应用程序密码。请务必将其保存在安全的位置，因为您无法再次查看密码。

更改现有应用程序的作用域

作用域是与 UiPath 资源相关的外部应用程序的权限。

1. 转到“管理” > “外部应用程序”。
2. 单击应用程序行右侧的 。
3. 更改应用程序有权访问的作用域：
   • 使用资源行右侧的图标编辑现有作用域或删除资源。
   • 单击“添加作用域”以添加其他资源并为其选择作用域。
4. 单击“保存”。

生成新的应用程序密码

如果您不知道为外部应用程序生成的应用程序密码，则无法恢复。但您可以生成新密码。

注意：如果您生成新的应用程序密码，请务必与维护与外部应用程序集成的开发者共享此密码。他们必须更新身份验证机制，否则现有集成将无法正常运作。

要生成新的应用程序密码，请执行以下操作：

1. 转到“管理” > “外部应用程序”。
2. 单击应用程序行右侧的 。
3. 在“应用程序密码”下，单击“生成新密码”。

   系统将生成新的应用程序密码，并将其显示在按钮上方。在您单击“取消”以关闭页面之前，它仍然可见。

4. 复制应用程序密码，并确保将其存储在安全位置。

向开发者提供详细信息

注册外部应用程序后，开发者还必须设置外部应用程序，以便其正确进行身份验证，从 UiPath Identity Server 请求授权，然后访问允许的 UiPath 资源。

为了能够执行这些任务，您必须与他们共享以下信息：

• 应用程序类型和应用程序 ID，两者均可在“管理” > “外部应用程序”页面上查看
• 为每个作用域类型添加的作用域。对于某些资源，用户和应用程序作用域使用相同的名称，因此类型也很重要。

• 如果这是机密应用程序，则在您注册外部应用程序时生成应用程序密码。

  注意： 如果您没有该密码，请按照上述说明生成一个新密码。

有关如何以开发者身份对外部应用程序进行身份验证和授权的更多详细信息，请参阅 API 指南中的外部应用程序。