UiPath Marketplace
最新
False
横幅背景图像
UiPath Marketplace 用户指南
上次更新日期 2024年4月16日

如何进行身份验证

使用 UiPath Orchestrator API 进行身份验证取决于您要连接到的 Orchestrator 实例的类型。 有两种类型的 Orchestrator 实例,两者都使用持有者令牌进行身份验证: Cloud OrchestratorOn-Premises Orchestrator



端点和输入

从身份验证的角度来看,实例类型之间有两个主要区别。 第一个是您向其发送请求的端点,第二个是身份验证请求所需的输入。

下表显示了每种实例类型的不同端点和输入,以及指向适用的 API 文档的链接。

 

Cloud Orchestrator

On-Premises Orchestrator

Endpoint

https://account.uipath.com/oauth/token

https://{{orchestrator-url}}/api/Account/Authenticate

输入

  • 帐户逻辑名称
  • 租户逻辑名称
  • 客户端 ID
  • 用户密钥
  • 文件夹 (可选)
  • Orchestrator URL
  • Orchestrator 租户名称
  • 电子邮件或用户名
  • 密码
  • 文件夹 (可选)

请求/响应

备注: Cloud Orchestrator:有关用户如何找到其客户端 ID用户密钥帐户逻辑名称租户逻辑名称的更多信息,请参阅 Orchestrator API 文档中的获取 API 访问信息

文件夹

两种实例类型都包含可选的文件夹输入。 文件夹用于对自动化及其内部实体,以及整个组织内的人员进行持续的细化控制。 Orchestrator 中有两种文件夹类型:传统和新式。 默认情况下启用传统文件夹,而必须由主机管理员或租户管理员启用新式文件夹功能。

如果用户输入“文件夹”值,则需要检索文件夹的 组织 单位 ID。 身份验证完成后,此标识符必须包含在所有后续 API 请求的标头中。

如何获取文件夹 OrganizationUnitId 值?

要检索 组织 单位 ID,您必须拥有 文件夹名称 并遵循下面列出的 API 请求。

  1. 使用文件夹名称作为输入参数,向GetFolders端点发送 GET 请求(例如{{base url}}/odata/Folders?$filter=FullyQualifiedName eq '{{FolderName}}' )。

    当用户的用户名已知时,您还可以检索文件夹的 组织 单位 ID,并在单个请求中验证其权限。 有关更多信息,请参见下文。

如何验证文件夹权限?

有多种方法可以验证用户是否有权访问特定文件夹。 如何验证权限取决于您是否拥有用户的用户名(而非电子邮件地址)。

选项 1 - 用户名未知

此选项适用于 Cloud Orchestrator 实例,以及仅知道用户电子邮件地址的 On-Premises Orchestrator 实例。

  1. 使用输入的凭据,通过向“获取当前用户”端点发送GET请求(例如{{base url}}/Users/Users_GetCurrentUser )来检索用户的用户名。
  2. 检索到包含 UserId 的 GET 响应后,使用 文件夹名称 UserId 作为输入参数,向 GetUsersForFolder 端点发送 GET 请求(例如{{base url}}/Folders/UiPath.Server.Configuration.OData.GetUsersForFolder(key={{*FolderOrganizationUnitId*}},includeInherited=true)?$filter=Id eq{{userId}} )。
选项 2 - 用户名已知

此选项适用于用户名已知的实例(通常,这仅适用于 On-Premises Orchestrator 实例)。

  1. 使用输入的用户名,通过用户名和跳过和获取端点向“获取用户的所有角色”发送 GET 请求(例如{{base url}}/Folders/UiPath.Server.Configuration.OData.GetAllRolesForUser(username='{{username}}',skip=0,take=0) )。
    • 响应中包含用户有权访问的所有文件夹。 通过解析响应,您可以验证响应是否包含用户输入的 文件夹名称 和/或在上一个请求中检索到的 组织 单位 ID。
    • 使用此选项的好处是,您可以获取文件夹的 组织 单位 ID 并在单个请求中验证权限。

多个用户

一个连接器可以与同一个或不同的 Orchestrator 租户建立多个经过身份验证的连接。 多个连接的目的是使多个用户能够访问和使用已实现的连接器功能(例如,启动作业、添加队列项目),而无需共享其 Orchestrator 凭据。





示例

本节提供指向示例连接器用户界面的链接,以及每个输入字段的相应 Orchestrator API 请求。

  • 端点和输入
  • 文件夹
  • 多个用户
  • 示例

此页面是否有帮助?

获取您需要的帮助
了解 RPA - 自动化课程
UiPath Community 论坛
Uipath 白色徽标
信任与安全
© 2005-2024 UiPath. All rights reserved.