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

Interface: UsersBackend

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/types.ts:104

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.

Extends

BackendBase

Properties

name

readonly name: "ocapi" | "scapi"

Defined in: packages/b2c-tooling-sdk/src/clients/scapi-backend-utils.ts:36

Inherited from

BackendBase.name

Methods

createOrReplaceUser()

createOrReplaceUser(login, input): Promise<UserInfo>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/types.ts:108

Parameters

string

input

CreateUserInput

Returns

Promise<UserInfo>

deleteUser()

deleteUser(login): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/types.ts:110

Parameters

string

Returns

Promise<void>

getUser()

getUser(login): Promise<UserInfo>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/types.ts:107

Parameters

string

Returns

Promise<UserInfo>

listUsers()

listUsers(options?): Promise<ListUsersResult>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/types.ts:105

Parameters

options?

ListUsersOptions

Returns

Promise<ListUsersResult>

searchUsers()

searchUsers(options?): Promise<ListUsersResult>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/types.ts:106

Parameters

options?

SearchUsersOptions

Returns

Promise<ListUsersResult>

updateUser()

updateUser(login, changes): Promise<UserInfo>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/types.ts:109

Parameters

string

changes

UpdateUserChanges

Returns

Promise<UserInfo>