orchestrator
2024.10
true
  • 入门指南
  • Swagger 定义
  • Orchestrator API
UiPath logo, featuring letters U and I in white

Orchestrator API 指南

Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
上次更新日期 2024年11月11日

用户请求

备注:
  • /odata/Users/odata/Users({}) 端点的 GET 请求将为 AD 用户返回空域。
  • GetOrganizationUnits(Id)GetRoles(Id) 请求仅返回为自动配置的用户显式设置的文件夹和角色。从组配置继承的文件夹和角色可通过 /api/DirectoryService/GetDirectoryPermissions?userId={userId} 端点检索。

删除用户

删除

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Users(446)

请求标头

密钥

授权

承载

响应代码

204 无内容

更改语言

通过以下示例,您可以将 ID 为 749 的用户的语言更改为日语。

发布

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Users(749)/UiPath.Server.Configuration.OData.ChangeUserCulture

请求标头

密钥

授权

承载

请求正文

{
    "culture": "ja"
}{
    "culture": "ja"
}

响应代码

200 OK

为用户配置机器人

放置

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Users(13)

请求标头

密钥

授权

承载

请求正文

{
  "RobotProvision": {
     "UserName": "uipath\\john.smith",
     "RobotId": 53,
     "RobotType": "Development",
     "ExecutionSettings": {}
  }
}{
  "RobotProvision": {
     "UserName": "uipath\\john.smith",
     "RobotId": 53,
     "RobotType": "Development",
     "ExecutionSettings": {}
  }
}

响应代码

200 OK

分配角色

您可以使用此端点将一个或多个角色分配给指定的用户 ID,该用户 ID 可以是组的 ID、用户帐户或机器人帐户。

发布

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Users(9)/UiPath.Server.Configuration.OData.AssignRoles

请求标头

密钥

授权

承载

请求正文

{
  "roleIds": [
    1,3
  ]
}{
  "roleIds": [
    1,3
  ]
}

示例

以下请求使用 ID 为 13的角色 覆盖 其分配的角色,从而更新用户 ID 为 9 的帐户或组。

请求之前的角色

请求后的角色

更改

无角色

13
已分配 ID 为 13 的角色。
ID 为 12的角色
13
已删除 ID 为 2 的角色,并分配了 ID 为 3 的角色。
ID 为 2的角色
13
已删除 ID 为 2 的角色,并分配了 ID 为 13 的角色。

cURL

curl -X POST "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Users({key})/UiPath.Server.Configuration.OData.AssignRoles" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"roleIds\": [ {RoleID1},{RoleID2} ] }"

Swagger 用户界面 (可在 https://https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/swagger获得)


一步一步

以下是有关如何将角色分配给帐户的示例过程:

  1. /odata/Roles 发出 GET 请求,以检索角色列表。

    如果需要,您可以使用 OData 支持的任何类型的筛选器。

  2. 记下要分配的角色的 ID。
  3. /odata/Users 发出 GET 请求,以检索帐户列表。

    该列表包括组、用户帐户和机器人帐户。

    如果需要,您可以使用 OData 支持的任何类型的筛选器。

  4. 记下要分配角色的帐户的 ID。
  5. 为要分配角色的每个帐户向 /odata/Users({key})/UiPath.Server.Configuration.OData.AssignRoles 发出 POST 请求。
    • {key} 是要为其分配角色的帐户的单个帐户 ID
    • {roleID} 是要分配的角色的单个角色 ID;您可以列出多个 ID,并以逗号分隔。

此页面有帮助吗?

获取您需要的帮助
了解 RPA - 自动化课程
UiPath Community 论坛
Uipath Logo White
信任与安全
© 2005-2024 UiPath。保留所有权利。