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

operations/bm-users

Business Manager user operations for B2C Commerce instances.

Provides functions for querying and managing instance-level users via OCAPI Data API. These are distinct from Account Manager users managed via @salesforce/b2c-tooling-sdk/operations/users | operations/users.

Create-or-replace is supported via the backend's createOrReplaceUser method (PUT), obtained from createUsersBackend. On instances using SSO with Account Manager (the default for production) this is rejected with LocalUserCreationException — local user creation must be enabled on the instance for it to succeed; otherwise provision users in Account Manager and use these operations for read/search/update/delete plus access-key administration.

Core User Functions

listBmUsers - List all users on an instance
getBmUser - Get a user by login
whoamiBmUser - Get the currently authenticated user
searchBmUsers - Search users with filter expressions
updateBmUser - Update user attributes (locale, external_id, disabled)
deleteBmUser - Delete a user from the instance

Access Keys (externally-managed users)

getBmUserAccessKey - Read access key details
createBmUserAccessKey - Create / rotate an access key
setBmUserAccessKeyEnabled - Enable / disable an access key
deleteBmUserAccessKey - Delete an access key

Usage

typescript

import {listBmUsers, searchBmUsers, createBmUserAccessKey} from '@salesforce/b2c-tooling-sdk/operations/bm-users';
import {resolveConfig} from '@salesforce/b2c-tooling-sdk/config';

const config = resolveConfig();
const instance = config.createB2CInstance();

// List all users
const users = await listBmUsers(instance);

// Search for locked users
const locked = await searchBmUsers(instance, {locked: true});

// Provision a WebDAV access key for a user
const key = await createBmUserAccessKey(instance, 'user@example.com', 'WEBDAV');
console.log(key.access_key); // Only returned at creation time