- 基本情報
- Swagger 定義
- Orchestrator API の使用例
ユーザーの要求
/odata/Usersまたは/odata/Users({})エンドポイントに GET 要求を送信すると、Active Directory ユーザーでは空のドメインが返されます。GetOrganizationUnits(Id)およびGetRoles(Id)要求を送信しても、自動プロビジョニングされたユーザーに明示的に設定されたフォルダーおよびロールしか返されません。グループの設定を継承したフォルダーやロールを取得するには、/api/DirectoryService/GetDirectoryPermissions?userId={userId}エンドポイントを使用してください。
PUT
https://cloud.uipath.com/{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": {}
}
}このエンドポイントを使用すると、指定したユーザー ID (グループ、ユーザー アカウント、またはロボット アカウントの ID) に 1 つ以上のロールを割り当てることができます。
POST
https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Users(9)/UiPath.Server.Configuration.OData.AssignRoles
{
"roleIds": [
1,3
]
}{
"roleIds": [
1,3
]
}例
9 であるアカウントまたはグループを更新します。そのために、割り当てられているロールを、ID が 1 および 3 のロールで上書きします。
|
要求前のロール |
要求後のロール |
変更箇所 |
|---|---|---|
|
ロールはありません。 |
1 ] と [ 3 |
ID が
1 および 3 のロールが割り当てられている
|
|
ID が
1 および 2 のロール |
1 ] と [ 3 |
ID
2 のロールが削除され、ID 3 のロールが割り当てられました。
|
|
ID が 2 のロール
2 |
1 ] と [ 3 |
ID
2 を含むロールが削除され、ID 1 と 3 を含むロールが割り当てられました。
|
cURL
curl -X POST "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Users({key})/UiPath.Server.Configuration.OData.AssignRoles" -H "accept: application/json" -H "Content-Type: application/json"
-d "{ \"roleIds\": [ {RoleID1},{RoleID2} ] }"
https://https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/swagger で利用可能)
アカウントにロールを割り当てる手順の例を以下に示します。
-
/odata/Rolesに GET 要求を送信し、ロールのリストを取得します。必要に応じて、OData がサポートする任意の種類のフィルターを使用できます。
- 割り当てるロールの ID をメモします。
-
/odata/Usersに GET 要求を送信し、アカウントのリストを取得します。このリストには、グループ、ユーザー アカウント、ロボット アカウントが含まれます。
必要に応じて、OData がサポートする任意の種類のフィルターを使用できます。
- ロールを割り当てるアカウントの ID をメモします。
-
ロールを割り当てるアカウントごとに、
/odata/Users({key})/UiPath.Server.Configuration.OData.AssignRolesに POST 要求を実行します。{key}は、ロールを割り当てるアカウントの 1 つのアカウント ID です。{roleID}は、割り当てるロールの 1 つのロール ID です。複数の ID を指定する場合は、各 ID をコンマで区切って記述できます。
