orchestrator
2020.10
false
Orchestrator API ガイド
- 基本情報
- Swagger の定義
- Orchestrator API
注:
/odata/Usersまたは/odata/Users({})エンドポイントに GET 要求を送信すると、Active Directory ユーザーでは空のドメインが返されます。GetOrganizationUnits(Id)およびGetRoles(Id)要求を送信しても、自動プロビジョニングされたユーザーに明示的に設定されたフォルダーおよびロールしか返されません。グループの設定を継承したフォルダーやロールを取得するには、/api/DirectoryService/GetDirectoryPermissions?userId={userId}エンドポイントを使用してください。
パスワードを更新する
POST
{OrchestratorURL}/odata/Users/UiPath.Server.Configuration.OData.UpdatePassword
要求ヘッダー
| キー | 値 (Value) |
|---|---|
| 認可 | Bearer |
要求本文
{
"TenancyName": "Documentation",
"Username": "DocTest",
"CurrentPassword": "YourCurrentPassword123$",
"NewPassword": "ANew567*Password"
}
{
"TenancyName": "Documentation",
"Username": "DocTest",
"CurrentPassword": "YourCurrentPassword123$",
"NewPassword": "ANew567*Password"
}
応答コード
200 OK
ユーザーを削除する
DELETE
{OrchestratorURL}/odata/Users(446)
要求ヘッダー
| キー | 値 (Value) |
|---|---|
| 認可 | Bearer |
応答コード
204 コンテンツなし
言語を変更する
以下の例では、ID が 749 のユーザーの言語を日本語に変更できます。
POST
{OrchestratorURL}/odata/Users(749)/UiPath.Server.Configuration.OData.ChangeUserCulture
要求ヘッダー
| キー | 値 (Value) |
|---|---|
| 認可 | Bearer |
要求本文
{
"culture": "ja"
}
{
"culture": "ja"
}
応答コード
200 OK
ユーザーにロボットをプロビジョニングする
PUT
{OrchestratorURL}/odata/Users(13)
要求ヘッダー
| キー | 値 (Value) |
|---|---|
| 認可 | Bearer |
要求本文
{
"RobotProvision": {
"UserName": "uipath\\john.smith",
"RobotId": 53,
"RobotType": "Development",
"ExecutionSettings": {}
}
}
{
"RobotProvision": {
"UserName": "uipath\\john.smith",
"RobotId": 53,
"RobotType": "Development",
"ExecutionSettings": {}
}
}
応答コード
200 OK
自身の Unattended ロボットのパスワードを更新する
PATCH
{OrchestratorURL}/odata/Users(88)
要求ヘッダー
| キー | 値 (Value) |
|---|---|
| 認可 | Bearer |
要求本文
{
"UnattendedRobot":
{
"Password": "newUnattendedRobotP@ss"
}
}
{
"UnattendedRobot":
{
"Password": "newUnattendedRobotP@ss"
}
}
応答コード
200 OK