feat(identity): onboard Users service with getById

First slice of the Identity user management onboarding: introduces the
modular Users service (@uipath/uipath-typescript/users) with

- getById(userId)  GET /api/User/{userId}

Identity routes at the organization level, so endpoints use a `../identity_`
base (IDENTITY_ORG_BASE) to collapse the tenant segment ApiClient inserts —
same pattern as the notification service.

Live-API findings encoded (Swagger spec is wrong on these): `type`/`category`
come back as numeric codes, not string enums — mapped to UserType/UserCategory
via value maps; internal `legacyId` is dropped.

Follow-up PRs add updateById/deleteById/create (with bound entity methods)
and invite.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Author: Sarath1018

docs/oauth-scopes.md

@@ -145,7 +145,6 @@ The `ConversationalAgents` scope is required for real-time WebSocket sessions (`
 |--------|-------------|
 | `getAll()` | `OR.Execution` or `OR.Execution.Read` |
 | `getById()` | `OR.Execution` or `OR.Execution.Read` |
-| `downloadCitationSource()` | NA |
 
 ### Conversations
 
@@ -272,3 +271,9 @@ The `ConversationalAgents` scope is required for real-time WebSocket sessions (`
 | `getSpansByReference()` | `Insights.RealTimeData Insights OR.Folders.Read` |
 | `getGovernanceDecisions()` | `Insights.RealTimeData Insights OR.Folders.Read` |
 | `getGovernanceSummary()` | `Insights.RealTimeData Insights OR.Folders.Read` |
+
+## Users
+
+| Method | OAuth Scope |
+|--------|-------------|
+| `getById()` | `PM.Users` or `PM.Users.Read` |

mkdocs.yml

@@ -208,6 +208,7 @@ nav:
           - Processes: api/interfaces/ProcessServiceModel.md
           - Queues: api/interfaces/QueueServiceModel.md
           - Tasks: api/interfaces/TaskServiceModel.md
+          - Users: api/interfaces/UserServiceModel.md
           - Traces:
             - api/interfaces/traces/index.md
             - Agent: api/interfaces/AgentTracesServiceModel.md
@@ -224,7 +225,7 @@ nav:
         - SDK Reference: coded-action-app-sdk/interfaces/CodedActionAppServiceModel.md
   - Plugins:
       - Codex: plugins/codex.md
-  - Sample Apps Gallery: samples/index.md
+  - Sample Application: https://github.com/UiPath/uipath-typescript/tree/main/samples
   - FAQ: FAQ.md
   - How To Contribute: CONTRIBUTING.md
   - Integration Testing: integration-testing.md

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@uipath/uipath-typescript",
-    "version": "1.5.5",
+    "version": "1.5.4",
     "description": "UiPath TypeScript SDK",
     "license": "MIT",
     "keywords": [
@@ -225,12 +225,21 @@
                 "types": "./dist/notifications/index.d.ts",
                 "default": "./dist/notifications/index.cjs"
             }
+        },
+        "./users": {
+            "import": {
+                "types": "./dist/users/index.d.ts",
+                "default": "./dist/users/index.mjs"
+            },
+            "require": {
+                "types": "./dist/users/index.d.ts",
+                "default": "./dist/users/index.cjs"
+            }
         }
     },
     "files": [
         "dist",
-        "README.md",
-        "docs/oauth-scopes.md"
+        "README.md"
     ],
     "scripts": {
         "prepack": "rimraf *.tgz",
@@ -242,7 +251,6 @@
         "docs:coded-action-app": "npm run docs --prefix packages/coded-action-app",
         "docs:post-process": "node scripts/docs-post-process.mjs",
         "lint": "oxlint",
-        "check:samples": "node scripts/check-samples.mjs",
         "typecheck": "tsc --noEmit",
         "test": "vitest",
         "test:unit": "vitest run",
@@ -276,7 +284,6 @@
         "@vitest/ui": "^4.1.9",
         "builtin-modules": "^3.3.0",
         "dotenv": "^17.2.0",
-        "node-html-parser": "^9.0.0",
         "oxlint": "^1.43.0",
         "rimraf": "^6.0.1",
         "rollup": "^4.60.4",

rollup.config.js

@@ -233,6 +233,11 @@ const serviceEntries = [
     name: 'notifications',
     input: 'src/services/notification/index.ts',
     output: 'notifications/index'
+  },
+  {
+    name: 'users',
+    input: 'src/services/identity/index.ts',
+    output: 'users/index'
   }
 ];
 

src/index.ts

@@ -19,6 +19,7 @@ export * from './models/conversational-agent';
 export * from './models/agents';
 export * as DuFramework from './models/document-understanding/framework';
 export * from './models/governance';
+export * from './models/identity';
 export * from './models/observability';
 
 // Export error handling functionality (public API only)

src/models/identity/index.ts

@@ -0,0 +1,6 @@
+/**
+ * Identity models barrel export.
+ */
+
+export * from './users.types';
+export * from './users.models';

src/models/identity/users.constants.ts

@@ -0,0 +1,34 @@
+import { UserType, UserCategory } from './users.types';
+
+/**
+ * User field mappings (API field name → SDK field name).
+ *
+ * Semantic renames only — the API already returns camelCase, so no case
+ * conversion is involved.
+ */
+export const UserMap: { [key: string]: string } = {
+  creationTime: 'createdTime',
+  lastModificationTime: 'lastModifiedTime',
+  groupIDs: 'groupIds',
+};
+
+/**
+ * Maps numeric user type codes (from API) to {@link UserType} enum values.
+ */
+export const UserTypeMap: { [key: number]: UserType } = {
+  0: UserType.User,
+  1: UserType.Robot,
+  2: UserType.DirectoryUser,
+  3: UserType.DirectoryGroup,
+  4: UserType.RobotAccount,
+  5: UserType.Application,
+};
+
+/**
+ * Maps numeric user category codes (from API) to {@link UserCategory} enum values.
+ */
+export const UserCategoryMap: { [key: number]: UserCategory } = {
+  0: UserCategory.Local,
+  1: UserCategory.LinkedLocal,
+  2: UserCategory.Directory,
+};

src/models/identity/users.internal-types.ts

@@ -0,0 +1,48 @@
+/**
+ * Internal-only types for the Identity Users service.
+ *
+ * NOT exported from the public barrel (`src/models/identity/index.ts`).
+ */
+
+/**
+ * Raw user shape as returned by the Identity user management API.
+ *
+ * Mirrors the API contract exactly: it uses the API's field names
+ * (`creationTime`, `groupIDs`, …) and numeric `type`/`category` codes — the
+ * Swagger spec declares string enums for these, but the live API returns
+ * numbers. The SDK renames/maps them before returning to consumers.
+ */
+export interface RawUserEntry {
+  id: string;
+  userName: string;
+  email: string;
+  emailConfirmed: boolean;
+  name: string | null;
+  surname: string | null;
+  displayName: string | null;
+  /** Renamed to `createdTime` in the SDK response. */
+  creationTime: string;
+  /** Renamed to `lastModifiedTime` in the SDK response. */
+  lastModificationTime: string | null;
+  lastLoginTime: string | null;
+  /** Renamed to `groupIds` in the SDK response. */
+  groupIDs: string[];
+  isActive: boolean;
+  bypassBasicAuthRestriction: boolean;
+  /** Numeric code mapped to the {@link UserType} enum in the SDK response. */
+  type: number;
+  /** Numeric code mapped to the {@link UserCategory} enum in the SDK response. */
+  category: number;
+  invitationAccepted: boolean;
+  // Internal field the SDK strips before returning to consumers:
+  /** Internal platform synchronization id — dropped from the SDK response. */
+  legacyId?: number;
+}
+
+/**
+ * Fields stripped from each {@link RawUserEntry} before it is returned to the
+ * SDK consumer.
+ */
+export const INTERNAL_USER_FIELDS = [
+  'legacyId',
+] as const satisfies ReadonlyArray<keyof RawUserEntry>;

src/models/identity/users.models.ts

@@ -0,0 +1,47 @@
+/**
+ * Identity Users service model — public response shapes and the ServiceModel
+ * interface that drives generated API documentation.
+ */
+
+import type { RawUserGetResponse } from './users.types';
+
+/**
+ * User returned by the Users service.
+ */
+export interface UserGetResponse extends RawUserGetResponse {}
+
+/**
+ * Service model for managing users in a UiPath organization.
+ *
+ * Provides organization-level user administration.
+ *
+ * ### Usage
+ *
+ * Prerequisites: Initialize the SDK first - see [Getting Started](/uipath-typescript/getting-started/#import-initialize)
+ *
+ * ```typescript
+ * import { Users } from '@uipath/uipath-typescript/users';
+ *
+ * const users = new Users(sdk);
+ * const user = await users.getById('<userId>');
+ * ```
+ */
+export interface UserServiceModel {
+  /**
+   * Gets a user by ID.
+   *
+   * Returns the full user details including profile fields, group membership,
+   * activity flags and invitation state.
+   *
+   * @param userId - User GUID
+   * @returns Promise resolving to the user
+   * {@link UserGetResponse}
+   *
+   * @example
+   * ```typescript
+   * const user = await users.getById('<userId>');
+   * console.log(`${user.displayName} (${user.email}) — active: ${user.isActive}`);
+   * ```
+   */
+  getById(userId: string): Promise<UserGetResponse>;
+}

src/models/identity/users.types.ts

@@ -0,0 +1,74 @@
+/**
+ * Identity user management types — response shapes and enums.
+ */
+
+/**
+ * Defines how a user was created and how it is supposed to be used.
+ */
+export enum UserType {
+  /** Standard interactive user. */
+  User = 'user',
+  /** Robot user driving unattended automation. */
+  Robot = 'robot',
+  /** User provisioned from an external directory (e.g. Azure AD). */
+  DirectoryUser = 'directoryUser',
+  /** Group provisioned from an external directory. */
+  DirectoryGroup = 'directoryGroup',
+  /** Robot account (non-interactive machine identity). */
+  RobotAccount = 'robotAccount',
+  /** External application identity. */
+  Application = 'application',
+}
+
+/**
+ * Discriminates a user by how they relate to directory provisioning.
+ */
+export enum UserCategory {
+  /** Local account managed in UiPath. */
+  Local = 'local',
+  /** Local account linked to a directory identity. */
+  LinkedLocal = 'linkedLocal',
+  /** Account provisioned from an external directory. */
+  Directory = 'directory',
+}
+
+/**
+ * User as returned by the Identity user management API.
+ *
+ * Field selection: `legacyId` (an internal platform synchronization field) is returned
+ * by the API but dropped from the SDK because it has no use for an application developer.
+ */
+export interface RawUserGetResponse {
+  /** User GUID. */
+  id: string;
+  /** The username. */
+  userName: string;
+  /** Email address. Empty string when the user has no email. */
+  email: string;
+  /** Whether the email address has been confirmed. */
+  emailConfirmed: boolean;
+  /** First name. */
+  name: string | null;
+  /** Last name. */
+  surname: string | null;
+  /** Display name. */
+  displayName: string | null;
+  /** When the user was created. */
+  createdTime: string;
+  /** When the user was last modified. */
+  lastModifiedTime: string | null;
+  /** When the user last logged in. `null` if the user has never logged in. */
+  lastLoginTime: string | null;
+  /** GUIDs of the groups the user is a member of. */
+  groupIds: string[];
+  /** Whether the user is active. */
+  isActive: boolean;
+  /** Whether this user bypasses the basic authentication restriction. */
+  bypassBasicAuthRestriction: boolean;
+  /** How the user was created and is supposed to be used. */
+  type: UserType;
+  /** How the user relates to directory provisioning. */
+  category: UserCategory;
+  /** Whether the user has accepted their invitation. */
+  invitationAccepted: boolean;
+}