orchestrator
2023.4
false
- 入门指南
- 身份验证
- Swagger 定义
- Orchestrator API
- 平台管理 API
重要 :
请注意此内容已使用机器翻译进行了部分本地化。
Orchestrator API 指南
Last updated 2024年12月5日
用户请求
备注:
- 对
/odata/Users
或/odata/Users({})
端点的 GET 请求将为 AD 用户返回空域。 GetOrganizationUnits(Id)
和GetRoles(Id)
请求仅返回为自动配置的用户显式设置的文件夹和角色。从组配置继承的文件夹和角色可通过/api/DirectoryService/GetDirectoryPermissions?userId={userId}
端点检索。
放置
https://{yourDomain}/odata/Users(13)
{
"RobotProvision": {
"UserName": "uipath\\john.smith",
"RobotId": 53,
"RobotType": "Development",
"ExecutionSettings": {}
}
}
{
"RobotProvision": {
"UserName": "uipath\\john.smith",
"RobotId": 53,
"RobotType": "Development",
"ExecutionSettings": {}
}
}
您可以使用此端点将一个或多个角色分配给指定的用户 ID,该用户 ID 可以是组的 ID、用户帐户或机器人帐户。
发布
https://{yourDomain}/odata/Users(9)/UiPath.Server.Configuration.OData.AssignRoles
{
"roleIds": [
1,3
]
}
{
"roleIds": [
1,3
]
}
示例
以下请求使用 ID 为
1
和 3
的角色 覆盖 其分配的角色,从而更新用户 ID 为 9
的帐户或组。
请求之前的角色 |
请求后的角色 |
更改 |
---|---|---|
无角色 |
1 和 3 |
已分配 ID 为
1 和 3 的角色。
|
ID 为
1 和 2 的角色 |
1 和 3 |
已删除 ID 为
2 的角色,并分配了 ID 为 3 的角色。
|
ID 为
2 的角色 |
1 和 3 |
已删除 ID 为
2 的角色,并分配了 ID 为 1 和 3 的角色。
|
cURL
curl -X POST "https://{yourDomain}/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}/swagger
获得)
以下是有关如何将角色分配给帐户的示例过程:
-
向
/odata/Roles
发出 GET 请求,以检索角色列表。如果需要,您可以使用 OData 支持的任何类型的筛选器。
- 记下要分配的角色的 ID。
-
向
/odata/Users
发出 GET 请求,以检索帐户列表。该列表包括组、用户帐户和机器人帐户。
如果需要,您可以使用 OData 支持的任何类型的筛选器。
- 记下要分配角色的帐户的 ID。
-
为要分配角色的每个帐户向
/odata/Users({key})/UiPath.Server.Configuration.OData.AssignRoles
发出 POST 请求。{key}
是要为其分配角色的帐户的单个帐户 ID{roleID}
是要分配的角色的单个角色 ID;您可以列出多个 ID,并以逗号分隔。