Orchestrator API 指南

适用平台：

上次更新日期 2024年6月18日

用户请求

备注：

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

更新密码

发布

{OrchestratorURL}/odata/Users/UiPath.Server.Configuration.OData.UpdatePassword

请求标头

密钥	值
授权	承载

请求正文

{
  "TenancyName": "Documentation",
  "Username": "DocTest",
  "CurrentPassword": "YourCurrentPassword123$",
  "NewPassword": "ANew567*Password"
}{
  "TenancyName": "Documentation",
  "Username": "DocTest",
  "CurrentPassword": "YourCurrentPassword123$",
  "NewPassword": "ANew567*Password"
}

响应代码

200 OK

删除用户

删除

{OrchestratorURL}/odata/Users(446)

请求标头

密钥	值
授权	承载

响应代码

204 无内容

更改语言

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

发布

{OrchestratorURL}/odata/Users(749)/UiPath.Server.Configuration.OData.ChangeUserCulture

请求标头

密钥	值
授权	承载

请求正文

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

响应代码

200 OK

为用户配置机器人

放置

{OrchestratorURL}/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

更新您自己的无人值守机器人的密码

补丁

{OrchestratorURL}/odata/Users(88)

请求标头

密钥	值
授权	承载

请求正文

{
"UnattendedRobot": 
   {
    "Password": "newUnattendedRobotP@ss"
    }
}{
"UnattendedRobot": 
   {
    "Password": "newUnattendedRobotP@ss"
    }
}