Users

Service model for managing users in a UiPath organization.

Provides organization-level user administration.

Usage

Prerequisites: Initialize the SDK first - see Getting Started

import { Users } from '@uipath/uipath-typescript/users';

const users = new Users(sdk);
const user = await users.getById('<userId>');

Methods

getById()

getById(userId: string): Promise<UserGetResponse>

Gets a user by ID.

Returns the full user details including profile fields, group membership, activity flags and invitation state.

Parameters

Parameter	Type	Description
userId	string	User GUID

Returns

Promise<UserGetResponse>

Promise resolving to a UserGetResponse with the user's profile fields, group membership, activity flags and invitation state

Example

const user = await users.getById('<userId>');
console.log(`${user.displayName} (${user.email}) — active: ${user.isActive}`);