How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

UiPath Users API

Manage users and their roles within Automation Hub

UiPath Users API is one of 32 APIs that UiPath publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 15 JSON Schema definitions.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a JSON-LD context, and 15 JSON Schemas.

This API exposes 8 operations across 7 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1.

8 operations 7 paths 10 schemas 1 DELETE4 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

UiPath Users API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — API token generated from the Automation Hub Admin Console under Platform Setup Open API. Include as a Bearer token in the Authorization header: "Bearer {token}…

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Users 8

Manage users and their roles within Automation Hub

GET
/users
UiPath List Users
listUsers 2 params → 200401
POST
/adduser
UiPath Add a User
addUser body → 201400401
POST
/edituser
UiPath Edit a User
editUser body → 200400401
GET
/roles
UiPath List Roles
listRoles → 200401
GET
/odata/Users
UiPath List Users
listUsers 3 params → 200401
GET
/{organizationName}/identity_/api/User/{userId}
UiPath Get a User by ID
getUser 2 params → 200401404
DELETE
/{organizationName}/identity_/api/User/{userId}
UiPath Delete a User
deleteUser 2 params → 204401404
POST
/{organizationName}/identity_/api/User
UiPath Create a User
createUser 1 param body → 201400401

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are User_2 (6 properties), User (5 properties), Role (3 properties), CreateUserRequest (3 properties). Each schema is shown below with its type and property counts.

EditUserRequest
object
Request payload for updating an existing user in Automation Hub
3 properties 1 required
Role
object
A role defining a set of permissions in Automation Hub
3 properties
AddUserRequest
object
Request payload for adding a new user to Automation Hub
2 properties 2 required
UserListResponse
object
Paginated response containing user records
2 properties
ODataUserCollection
object
OData collection response containing users
1 property
User
object
A user in Automation Hub
5 properties
ErrorResponse
object
Standard error response body
2 properties
CreateUserRequest
object
Request payload for creating a new user account
3 properties 2 required
ErrorResponse_3
object
Standard error response body
3 properties
User_2
object
A user account in the UiPath organization
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

uipath-users-api-openapi.yml Raw ↑

Other APIs UiPath publishes across the network.

UiPath Alerts API
UiPath AppInventory API
UiPath Assets API
UiPath AuditLogs API
UiPath Automations API
UiPath Classification API
UiPath Digitization API
UiPath Discovery API
UiPath Entities API
UiPath Extraction API
UiPath Folders API
UiPath Groups API
Where this information came from

This is an independent, third-party profile of UiPath Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.