@salesforce/b2c-tooling-sdk / operations/bm-users / ScapiUsersBackend

Class: ScapiUsersBackend

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:61

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

Constructors

Constructor

new ScapiUsersBackend(config): ScapiUsersBackend

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:67

Parameters

config

ScapiUsersBackendConfig

Returns

ScapiUsersBackend

Properties

name

readonly name: "scapi"

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:62

Implementation of

UsersBackend.name

Methods

createOrReplaceUser()

createOrReplaceUser(login, input): Promise<UserInfo>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:157

Parameters

login

string

input

CreateUserInput

Returns

Promise<UserInfo>

Implementation of

UsersBackend.createOrReplaceUser

---

deleteUser()

deleteUser(login): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:221

Parameters

login

string

Returns

Promise<void>

Implementation of

UsersBackend.deleteUser

---

getUser()

getUser(login): Promise<UserInfo>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:145

Parameters

login

string

Returns

Promise<UserInfo>

Implementation of

UsersBackend.getUser

---

listUsers()

listUsers(options): Promise<ListUsersResult>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:77

Parameters

options

ListUsersOptions = {}

Returns

Promise<ListUsersResult>

Implementation of

UsersBackend.listUsers

---

searchUsers()

searchUsers(options): Promise<ListUsersResult>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:100

Parameters

options

SearchUsersOptions = {}

Returns

Promise<ListUsersResult>

Implementation of

UsersBackend.searchUsers

---

updateUser()

updateUser(login, changes): Promise<UserInfo>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:181

Parameters

login

string

changes

UpdateUserChanges

Returns

Promise<UserInfo>

Implementation of

UsersBackend.updateUser