Orchestrator
2020.10
false
  • Getting Started
  • The Swagger Definition
  • Examples using the Orchestrator API
Banner background image
OUT OF SUPPORT
Orchestrator API Guide
Last updated Dec 12, 2023

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.

Updating Your Password

POST

{OrchestratorURL}/odata/Users/UiPath.Server.Configuration.OData.UpdatePassword

Request headers

Key

Value

Authorization

Bearer

Request body

{
  "TenancyName": "Documentation",
  "Username": "DocTest",
  "CurrentPassword": "YourCurrentPassword123$",
  "NewPassword": "ANew567*Password"
}{
  "TenancyName": "Documentation",
  "Username": "DocTest",
  "CurrentPassword": "YourCurrentPassword123$",
  "NewPassword": "ANew567*Password"
}

Response code

200 OK

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": {}
  }
}

Response code

200 OK

Updating the Password for Your Own Unattended Robot

PATCH

{OrchestratorURL}/odata/Users(88)

Request headers

Key

Value

Authorization

Bearer

Request body

{
"UnattendedRobot": 
   {
    "Password": "newUnattendedRobotP@ss"
    }
}{
"UnattendedRobot": 
   {
    "Password": "newUnattendedRobotP@ss"
    }
}

Response code

200 OK

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.