orchestrator
2020.10
false
- Getting Started
- Swagger Definition
- Orchestrator APIs- Assets Requests
- Calendars Requests
- Environments Requests
- Folders Requests
- Generic Tasks Requests
- Jobs Requests
- Libraries Requests
- License Requests
- Packages Requests
- Permissions Requests
- Processes Requests
- Robots Requests
- Roles Requests
- Schedules Requests
- Settings Requests
- Tasks Requests
- Task Catalogs Requests
- Task Forms Requests
- Tenants Requests
- Transactions Requests
- Users Requests
- Webhooks Requests
 

OUT OF SUPPORT
Orchestrator API Guide
Last updated Jun 18, 2024
Note: 
               
            
            
         - GET requests to the /odata/Usersor/odata/Users({})endpoints return an empty Domain for AD users.
- The GetOrganizationUnits(Id)andGetRoles(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.
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
DELETE
{OrchestratorURL}/odata/Users(446)
Request headers
| Key | Value | 
|---|---|
| Authorization | Bearer | 
Response code
204 No content
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
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 Your Password
- Request headers
- Request body
- Response code
- Deleting a User
- Request headers
- Response code
- Changing the Language
- Request headers
- Request body
- Response code
- Provisioning a Robot for a User
- Request headers
- Request body
- Response code
- Updating the Password for Your Own Unattended Robot
- Request headers
- Request body
- Response code