Orchestrator API Guide

DELIVERY:

Last updated Oct 31, 2024

Users Requests

Note:

GET requests to the /odata/Users or /odata/Users({}) endpoints return an empty Domain for AD users.
The GetOrganizationUnits(Id) and GetRoles(Id) requests only return folders and roles explicitly set for an auto-provisioned user. The ones inherited from the group configuration can be retrieved through the /api/DirectoryService/GetDirectoryPermissions?userId={userId} endpoint.

Deleting a User

DELETE

{OrchestratorURL}/odata/Users(446)

Request headers

Key	Value
Authorization	Bearer

Response code

204 No content

Changing the Language

The following example enables you to change the language for the user with the 749 Id to Japanese.

POST

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

Request headers

Key	Value
Authorization	Bearer

Request body

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

Response code

200 OK

Provisioning a Robot for a User

PUT

{OrchestratorURL}/odata/Users(13)

Request headers

Key	Value
Authorization	Bearer

Request body

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