UiPath Documentation
orchestrator
2021.10
false
  • Getting Started
    • About OData and References
    • Enumerated Types
    • Authenticating
    • Building API Requests
    • Permissions Per Endpoint
    • Response Codes
    • Health Check Endpoints
  • Authentication
    • Authentication methods
    • External Applications (OAuth)
    • ROPC (not recommended)
  • Swagger Definition
    • Read Me
    • Authorizing API Calls in Swagger
    • Managing Logical Resources
  • Orchestrator APIs
    • Alerts Requests
    • 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
  • Platform Management APIs
    • Getting started
      • About this guide
      • Available resources
      • API endpoint URL structure
      • Enumeration List
    • Scopes and permissions
      • About scopes and permissions
      • Platform Management scopes and permissions
    • Platform Management APIs
      • Audit Logs
        • Get Audit Logs
        • Download Audit Logs
      • [Preview] Groups
        • [Preview] Get All Groups
        • [Preview] Delete Groups
        • [Preview] Get Specific Group
        • [Preview] Delete Specific Group
        • [Preview] Create a New Local Group
        • [Preview] Update Group
      • [Preview] Robot Account
        • [Preview] Get All Robot Accounts
        • [Preview] Delete Robot Accounts
        • [Preview] Get Specific Robot Account
        • [Preview] Delete Specific Robot Account
        • [Preview] Create a New Robot Account
        • [Preview] Update Robot Account
      • [Preview] User
        • [Preview] Update User
        • [Preview] Delete Specific User
        • [Preview] Delete Users
        • [Preview] Update User Password
      • [Preview] Settings
        • [Preview] Update Settings
      • Message Template
        • Get Message Template
        • Update a Message Template
        • Get Message Template by Name
UiPath logo, featuring letters U and I in white
OUT OF SUPPORT

Orchestrator API Guide

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

Response code

200 OK

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated