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

Class: OcapiUsersBackend

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

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 OcapiUsersBackend(instance): OcapiUsersBackend

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

Parameters

instance

B2CInstance

Returns

OcapiUsersBackend

Properties

name

readonly name: "ocapi"

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

Implementation of

UsersBackend.name

Methods

createOrReplaceUser()

createOrReplaceUser(login, input): Promise<UserInfo>

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

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/ocapi-backend.ts:117

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/ocapi-backend.ts:63

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/ocapi-backend.ts:52

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/ocapi-backend.ts:68

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/ocapi-backend.ts:103

Parameters

login

string

changes

UpdateUserChanges

Returns

Promise<UserInfo>

Implementation of

UsersBackend.updateUser