Orchestrator Users
Service for listing the users of a UiPath Orchestrator tenant.
Orchestrator users are the accounts — people, groups, robots and external applications — that can sign in to a tenant and hold roles in it. Managing user access
Usage¶
Prerequisites: Initialize the SDK first - see Getting Started
import { OrchestratorUsers } from '@uipath/uipath-typescript/orchestrator-users';
const orchestratorUsers = new OrchestratorUsers(sdk);
const allUsers = await orchestratorUsers.getAll();
Methods¶
getAll()¶
getAll<
T>(options?:T):Promise<TextendsHasPaginationOptions<T> ?PaginatedResponse<OrchestratorUserGetResponse> :NonPaginatedResponse<OrchestratorUserGetResponse>>
Gets the users of the tenant with optional filtering, sorting, projection and pagination.
This is a tenant-level read — no folder context is involved. Each user carries its
type (person, directory group, robot, …), role names, license type, and the
activity and session flags that govern what the account may do. Robot-provisioning
configuration and credential fields are intentionally not exposed. Add
expand: 'userRoles' to include each user's role assignments.
Type Parameters¶
| Type Parameter | Default type |
|---|---|
T extends OrchestratorUserGetAllOptions |
OrchestratorUserGetAllOptions |
Parameters¶
| Parameter | Type | Description |
|---|---|---|
options? |
T |
Query options (filter, orderby, select, expand) and pagination options. Filter, sort, select and expand expressions use the SDK field names, for example createdTime. |
Returns¶
Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<OrchestratorUserGetResponse> : NonPaginatedResponse<OrchestratorUserGetResponse>>
Promise resolving to a NonPaginatedResponse of OrchestratorUserGetResponse items, or to a PaginatedResponse of OrchestratorUserGetResponse items when pagination options are used.
Examples¶
// Active directory users, newest first, one page at a time
const page1 = await orchestratorUsers.getAll({
filter: "isActive eq true and type eq 'DirectoryUser'",
orderby: 'createdTime desc',
pageSize: 50
});
if (page1.hasNextPage) {
const page2 = await orchestratorUsers.getAll({ cursor: page1.nextCursor });
}