UiPath Marketplace 用户指南

上次更新日期 2024年9月5日

如何进行身份验证

使用 UiPath Orchestrator API 进行身份验证取决于您要连接到的 Orchestrator 实例的类型。有两种类型的 Orchestrator 实例，两者都使用持有者令牌进行身份验证： Cloud Orchestrator 和 On-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 租户名称电子邮件或用户名密码文件夹 (可选)
请求/响应	API 大摇大摆 Postman	API 大摇大摆 Postman

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

文件夹

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

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

如何获取文件夹 OrganizationUnitId 值？

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

使用“文件夹名称” 作为输入参数，向“获取文件夹”端点发送 GET 请求（例如{{base url}}/odata/Folders?$filter=FullyQualifiedName eq '{{FolderName}}' ）。

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

如何验证文件夹权限？

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

选项 1 - 用户名未知

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

使用输入的凭据，通过向 GetCurrentUser 端点发送 GET 请求来检索用户的用户 ID （例如{{base url}}/Users/Users_GetCurrentUser ）。
检索到包含 UserId 的 GET 响应后，使用 文件夹名称 和用户 ID 作为输入参数（例如{{base url}}/Folders/UiPath.Server.Configuration.OData.GetUsersForFolder(key={{*FolderOrganizationUnitId*}},includeInherited=true)?$filter=Id eq{{userId}} ），向 GetUsersForFolder 端点发送 GET 请求。

选项 2 - 用户名已知

此选项适用于用户名已知的实例（通常，这仅适用于 On-Premises Orchestrator 实例）。

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