@salesforce/b2c-tooling-sdk / operations/bm-roles
operations/bm-roles ​
Business Manager role operations for B2C Commerce instances.
This module provides functions for managing instance-level access roles on B2C Commerce instances via the OCAPI Data API. These are distinct from Account Manager roles managed via @salesforce/b2c-tooling-sdk/operations/roles | operations/roles.
Core Role Functions ​
- listBmRoles - List all access roles on an instance
- getBmRole - Get role details with optional expansion
- createBmRole - Create a new access role
- deleteBmRole - Delete an access role
User Assignment ​
- grantBmRole - Assign a user to a role
- revokeBmRole - Unassign a user from a role
Permissions ​
- getBmRolePermissions - Get permissions for a role
- setBmRolePermissions - Replace all permissions for a role
Usage ​
typescript
import {listBmRoles, grantBmRole, getBmRolePermissions} from '@salesforce/b2c-tooling-sdk/operations/bm-roles';
import {resolveConfig} from '@salesforce/b2c-tooling-sdk/config';
const config = resolveConfig();
const instance = config.createB2CInstance();
// List all roles
const roles = await listBmRoles(instance);
// Grant a role to a user
await grantBmRole(instance, 'Administrator', 'user@example.com');
// Get permissions for a role
const permissions = await getBmRolePermissions(instance, 'Administrator');Authentication ​
BM role operations require OAuth authentication with appropriate OCAPI permissions for the /roles resource.