ユーザーの要求

注:

• /odata/Users または /odata/Users({}) エンドポイントに GET 要求を送信すると、Active Directory ユーザーでは空のドメインが返されます。
• GetOrganizationUnits(Id) および GetRoles(Id) 要求を送信しても、自動プロビジョニングされたユーザーに明示的に設定されたフォルダーおよびロールしか返されません。グループの設定を継承したフォルダーやロールを取得するには、/api/DirectoryService/GetDirectoryPermissions?userId={userId} エンドポイントを使用してください。

ユーザーを削除する

DELETE

https://{yourDomain}/odata/Users(446)

要求ヘッダー

キー	値 (Value)
認可	Bearer

応答コード

204 コンテンツなし

言語を変更する

以下の例では、ID が 749 のユーザーの言語を日本語に変更できます。

POST

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

要求ヘッダー

キー	値 (Value)
認可	Bearer

要求本文

{
    "culture": "ja"
}

応答コード

200 OK

ユーザーにロボットをプロビジョニングする

PUT

https://{yourDomain}/odata/Users(13)

要求ヘッダー

キー	値 (Value)
認可	Bearer

要求本文

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

応答コード

200 OK

ロールを割り当てる

このエンドポイントを使用すると、指定したユーザー ID (グループ、ユーザー アカウント、またはロボット アカウントの ID) に 1 つ以上のロールを割り当てることができます。

POST

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

要求ヘッダー

キー	値 (Value)
認可	Bearer

要求本文

{
  "roleIds": [
    1,3
  ]
}

例

以下の要求は、アカウントまたはグループに割り当てられたロールを ID が 1 と 3を持つロールで上書きして、ユーザー ID が 9 で更新されます。

要求前のロール	要求後のロール	変更箇所
ロールはありません。	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://{yourDomain}/odata/Users({key})/UiPath.Server.Configuration.OData.AssignRoles" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"roleIds\": [ {RoleID1},{RoleID2} ] }"

Swagger UI ( https://https://{yourDomain}/swaggerで利用可能)

図 1. ロールを割り当てる

ステップ バイ ステップの手順

アカウントにロールを割り当てる手順の例を以下に示します。

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} は、ロールを割り当てるアカウントの 1 つのアカウント ID です。
   • {roleID} は、割り当てるロールの 1 つのロール ID です。複数の ID を指定する場合は、各 ID をコンマで区切って記述できます。