@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.
On instances using SSO with Account Manager (the default for production), creating local BM users via the Data API is rejected with LocalUserCreationException. These operations focus on read/search/lifecycle of AM-managed users 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