[PERS SDK - v2.3.26](/sdk-reference/readme) / [Exports](/sdk-reference/modules) / UserApi

# Class: UserApi

Platform-Agnostic User API Client

Handles user operations using the PERS backend RESTful API.
Updated to use new /users endpoints with enhanced security and consistency.
Maintains framework UserApiService method compatibility.

## Table of contents

### Constructors

- [constructor](/sdk-reference/classes/userapi#constructor)


### Methods

- [getAllUsersPublicProfiles](/sdk-reference/classes/userapi#getalluserspublicprofiles)
- [getPublicProfileById](/sdk-reference/classes/userapi#getpublicprofilebyid)
- [getRemoteUser](/sdk-reference/classes/userapi#getremoteuser)
- [updateRemoteUser](/sdk-reference/classes/userapi#updateremoteuser)
- [createOrUpdateUser](/sdk-reference/classes/userapi#createorupdateuser)
- [createOrUpdateUsers](/sdk-reference/classes/userapi#createorupdateusers)
- [getAllRemoteUsers](/sdk-reference/classes/userapi#getallremoteusers)
- [updateUserAsAdmin](/sdk-reference/classes/userapi#updateuserasadmin)
- [setUserActiveStatus](/sdk-reference/classes/userapi#setuseractivestatus)
- [getUserByUniqueIdentifier](/sdk-reference/classes/userapi#getuserbyuniqueidentifier)
- [deleteUser](/sdk-reference/classes/userapi#deleteuser)
- [restoreUser](/sdk-reference/classes/userapi#restoreuser)
- [exportCSV](/sdk-reference/classes/userapi#exportcsv)


## Constructors

### constructor

• **new UserApi**(`apiClient`): [`UserApi`](/sdk-reference/classes/userapi)

#### Parameters

| Name | Type |
|  --- | --- |
| `apiClient` | [`PersApiClient`](/sdk-reference/classes/persapiclient) |


#### Returns

[`UserApi`](/sdk-reference/classes/userapi)

#### Defined in

[user/api/user-api.ts:24](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/user/api/user-api.ts#L24)

## Methods

### getAllUsersPublicProfiles

▸ **getAllUsersPublicProfiles**(`filter?`, `options?`): `Promise`<`PaginatedResponseDTO`<[`UserPublicProfileDTO`](/sdk-reference/interfaces/userpublicprofiledto)>>

PUBLIC: Get all users public profiles with optional filtering
Uses new RESTful /users/public endpoint

#### Parameters

| Name | Type | Default value |
|  --- | --- | --- |
| `filter` | `null` | { `key`: `string` ; `value`: `string`  } | `null` |
| `options?` | `PaginationOptions` | `undefined` |


#### Returns

`Promise`<`PaginatedResponseDTO`<[`UserPublicProfileDTO`](/sdk-reference/interfaces/userpublicprofiledto)>>

#### Defined in

[user/api/user-api.ts:36](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/user/api/user-api.ts#L36)

### getPublicProfileById

▸ **getPublicProfileById**(`id`): `Promise`<[`UserPublicProfileDTO`](/sdk-reference/interfaces/userpublicprofiledto)>

PUBLIC: Get a single user's public profile by ID
Uses RESTful /users/public/:id endpoint

#### Parameters

| Name | Type |
|  --- | --- |
| `id` | `string` |


#### Returns

`Promise`<[`UserPublicProfileDTO`](/sdk-reference/interfaces/userpublicprofiledto)>

#### Defined in

[user/api/user-api.ts:65](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/user/api/user-api.ts#L65)

### getRemoteUser

▸ **getRemoteUser**(`options?`): `Promise`<`UserDTO`>

AUTH: Get current authenticated user
Uses new RESTful /users/me endpoint

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `options?` | `UserQueryParams` | Query options. Use `include` to specify relations: 'status' (user status types), 'balances' (token balances) |


#### Returns

`Promise`<`UserDTO`>

#### Defined in

[user/api/user-api.ts:79](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/user/api/user-api.ts#L79)

### updateRemoteUser

▸ **updateRemoteUser**(`updateRequest`): `Promise`<`UserDTO`>

AUTH: Update current authenticated user
Uses new RESTful /users/me endpoint

#### Parameters

| Name | Type |
|  --- | --- |
| `updateRequest` | `UserCreateRequestDTO` |


#### Returns

`Promise`<`UserDTO`>

#### Defined in

[user/api/user-api.ts:91](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/user/api/user-api.ts#L91)

### createOrUpdateUser

▸ **createOrUpdateUser**(`userData`): `Promise`<`UserDTO`>

BUSINESS/ADMIN: Create or update user account

Creates a new user or updates an existing one.

- Business auth: Can create/update single users (requires canManageUsers permission)
- Admin auth: Can create/update single users or bulk operations


#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `userData` | `UserCreateRequestDTO` | User data for creation/update |


#### Returns

`Promise`<`UserDTO`>

Created or updated user

#### Defined in

[user/api/user-api.ts:109](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/user/api/user-api.ts#L109)

### createOrUpdateUsers

▸ **createOrUpdateUsers**(`users`): `Promise`<`UserDTO`[]>

ADMIN: Bulk create or update users

Creates or updates multiple users in a single operation.
Requires admin authentication - business auth cannot perform bulk operations.

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `users` | `UserCreateRequestDTO`[] | Array of user data for creation/update |


#### Returns

`Promise`<`UserDTO`[]>

Array of created/updated users

#### Defined in

[user/api/user-api.ts:122](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/user/api/user-api.ts#L122)

### getAllRemoteUsers

▸ **getAllRemoteUsers**(`options?`, `search?`): `Promise`<`PaginatedResponseDTO`<`UserDTO`>>

ADMIN: Get all remote users with query parameters
Uses new RESTful /users endpoint with role-based access
Note: Admin users get full data, non-admin users get public profiles only

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `options?` | `PaginationOptions` | Pagination options (page, limit, sortBy, sortOrder) |
| `search?` | `string` | Optional search query to filter users |


#### Returns

`Promise`<`PaginatedResponseDTO`<`UserDTO`>>

**`Example`**

```typescript
// Get users sorted by email
const users = await sdk.users.getAllUsers({ 
  page: 1, 
  limit: 10, 
  sortBy: 'email', 
  sortOrder: SortOrder.ASC 
});

// Search for users
const searchResults = await sdk.users.getAllUsers({ page: 1, limit: 10 }, 'john');
```

#### Defined in

[user/api/user-api.ts:148](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/user/api/user-api.ts#L148)

### updateUserAsAdmin

▸ **updateUserAsAdmin**(`id`, `userData`): `Promise`<`UserDTO`>

ADMIN: Update user as admin
Uses new RESTful /users/{id} endpoint

#### Parameters

| Name | Type |
|  --- | --- |
| `id` | `string` |
| `userData` | `UserCreateRequestDTO` |


#### Returns

`Promise`<`UserDTO`>

#### Defined in

[user/api/user-api.ts:162](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/user/api/user-api.ts#L162)

### setUserActiveStatus

▸ **setUserActiveStatus**(`userId`, `isActive?`): `Promise`<`UserDTO`>

ADMIN: Set or toggle user active status
Uses new consistent /users/{id}/status endpoint
Enhanced: Follows RESTful status management pattern across all domains

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `userId` | `string` | User ID |
| `isActive?` | `boolean` | Optional explicit status. If provided, sets to this value. If omitted, toggles current status. |


#### Returns

`Promise`<`UserDTO`>

**`Example`**

```typescript
// Explicit set
await sdk.users.setUserActiveStatus('user-123', true);   // Activate
await sdk.users.setUserActiveStatus('user-123', false);  // Deactivate

// Toggle (current behavior)
await sdk.users.setUserActiveStatus('user-123');  // Flips current status
```

#### Defined in

[user/api/user-api.ts:184](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/user/api/user-api.ts#L184)

### getUserByUniqueIdentifier

▸ **getUserByUniqueIdentifier**(`id`, `options?`): `Promise`<`UserDTO`>

ADMIN: Get user by unique identifier
Uses new RESTful /users/{id} endpoint

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `id` | `string` | User unique identifier (id, email, externalId, accountAddress, etc.) |
| `options?` | `UserQueryParams` | Query options. Use `include` to specify relations: 'status' (user status types), 'balances' (token balances) |


#### Returns

`Promise`<`UserDTO`>

#### Defined in

[user/api/user-api.ts:196](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/user/api/user-api.ts#L196)

### deleteUser

▸ **deleteUser**(`identifier`): `Promise`<{ `success`: `boolean` ; `message`: `string`  }>

ADMIN: Delete user by identifier (soft delete)
Uses RESTful /users/{identifier} DELETE endpoint

Soft deletes a user. The user data is retained for 30 days before GDPR anonymization.
Use restoreUser() to restore within the grace period.

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `identifier` | `string` | User unique identifier (id, email, externalId, accountAddress, etc.) |


#### Returns

`Promise`<{ `success`: `boolean` ; `message`: `string`  }>

Promise resolving to success status and message

#### Defined in

[user/api/user-api.ts:214](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/user/api/user-api.ts#L214)

### restoreUser

▸ **restoreUser**(`identifier`): `Promise`<`UserDTO`>

ADMIN: Restore deleted user by identifier
Uses RESTful /users/{identifier}/restore POST endpoint

Restores a soft-deleted user within the 30-day grace period.
After GDPR anonymization (30 days), restoration is not possible.

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `identifier` | `string` | User unique identifier (id, email, externalId, accountAddress, etc.) |


#### Returns

`Promise`<`UserDTO`>

Promise resolving to restored user data

#### Defined in

[user/api/user-api.ts:228](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/user/api/user-api.ts#L228)

### exportCSV

▸ **exportCSV**(`options?`): `Promise`<`Blob`>

ADMIN: Export users to CSV

Returns a CSV file with user data for the tenant.
Supports date range filtering.

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `options?` | `Object` | Export options (dateFrom, dateTo in ISO format) |
| `options.dateFrom?` | `string` | - |
| `options.dateTo?` | `string` | - |


#### Returns

`Promise`<`Blob`>

CSV blob

**`Example`**

```typescript
// Export all users
const blob = await sdk.users.exportCSV();

// Export users created in date range
const blob = await sdk.users.exportCSV({
  dateFrom: '2026-01-01',
  dateTo: '2026-05-31'
});
```

#### Defined in

[user/api/user-api.ts:257](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/user/api/user-api.ts#L257)