---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../../modules.md) / [operations/bm-users](../index.md) / ScapiUsersBackend

# Class: ScapiUsersBackend

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:61](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts#L61)

Backend contract for BM user operations.

Merchant Users has no server-side search endpoint, so the SCAPI backend
implements portable search criteria over its paginated user listing.
Raw OCAPI query DSL, access keys, and `whoami` remain OCAPI-only.

## Implements

- [`UsersBackend`](../interfaces/UsersBackend.md)

## Constructors

### Constructor

> **new ScapiUsersBackend**(`config`): `ScapiUsersBackend`

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:67](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts#L67)

#### Parameters

##### config

[`ScapiUsersBackendConfig`](../interfaces/ScapiUsersBackendConfig.md)

#### Returns

`ScapiUsersBackend`

## Properties

### name

> `readonly` **name**: `"scapi"`

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:62](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts#L62)

#### Implementation of

[`UsersBackend`](../interfaces/UsersBackend.md).[`name`](../interfaces/UsersBackend.md#name)

## Methods

### createOrReplaceUser()

> **createOrReplaceUser**(`login`, `input`): `Promise`\<[`UserInfo`](../interfaces/UserInfo.md)\>

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:157](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts#L157)

#### Parameters

##### login

`string`

##### input

[`CreateUserInput`](../interfaces/CreateUserInput.md)

#### Returns

`Promise`\<[`UserInfo`](../interfaces/UserInfo.md)\>

#### Implementation of

[`UsersBackend`](../interfaces/UsersBackend.md).[`createOrReplaceUser`](../interfaces/UsersBackend.md#createorreplaceuser)

***

### deleteUser()

> **deleteUser**(`login`): `Promise`\<`void`\>

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:221](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts#L221)

#### Parameters

##### login

`string`

#### Returns

`Promise`\<`void`\>

#### Implementation of

[`UsersBackend`](../interfaces/UsersBackend.md).[`deleteUser`](../interfaces/UsersBackend.md#deleteuser)

***

### getUser()

> **getUser**(`login`): `Promise`\<[`UserInfo`](../interfaces/UserInfo.md)\>

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:145](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts#L145)

#### Parameters

##### login

`string`

#### Returns

`Promise`\<[`UserInfo`](../interfaces/UserInfo.md)\>

#### Implementation of

[`UsersBackend`](../interfaces/UsersBackend.md).[`getUser`](../interfaces/UsersBackend.md#getuser)

***

### listUsers()

> **listUsers**(`options`): `Promise`\<[`ListUsersResult`](../interfaces/ListUsersResult.md)\>

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:77](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts#L77)

#### Parameters

##### options

[`ListUsersOptions`](../interfaces/ListUsersOptions.md) = `{}`

#### Returns

`Promise`\<[`ListUsersResult`](../interfaces/ListUsersResult.md)\>

#### Implementation of

[`UsersBackend`](../interfaces/UsersBackend.md).[`listUsers`](../interfaces/UsersBackend.md#listusers)

***

### searchUsers()

> **searchUsers**(`options`): `Promise`\<[`ListUsersResult`](../interfaces/ListUsersResult.md)\>

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:100](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts#L100)

#### Parameters

##### options

[`SearchUsersOptions`](../interfaces/SearchUsersOptions.md) = `{}`

#### Returns

`Promise`\<[`ListUsersResult`](../interfaces/ListUsersResult.md)\>

#### Implementation of

[`UsersBackend`](../interfaces/UsersBackend.md).[`searchUsers`](../interfaces/UsersBackend.md#searchusers)

***

### updateUser()

> **updateUser**(`login`, `changes`): `Promise`\<[`UserInfo`](../interfaces/UserInfo.md)\>

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:181](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts#L181)

#### Parameters

##### login

`string`

##### changes

[`UpdateUserChanges`](../interfaces/UpdateUserChanges.md)

#### Returns

`Promise`\<[`UserInfo`](../interfaces/UserInfo.md)\>

#### Implementation of

[`UsersBackend`](../interfaces/UsersBackend.md).[`updateUser`](../interfaces/UsersBackend.md#updateuser)