Skip to content

@salesforce/b2c-tooling-sdk / operations/bm-roles / createBmRole

Function: createBmRole() ​

createBmRole(instance, roleId, role): Promise<{ }>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/roles.ts:122

Creates a new access role on an instance.

Parameters ​

instance ​

B2CInstance

B2C instance

roleId ​

string

Role ID to create

role ​

Role properties (description, etc.)

description? ​

string

Returns ​

Promise<{ }>

Created role

Example ​

typescript
const role = await createBmRole(instance, 'MyCustomRole', { description: 'A custom role' });

Released under the Apache-2.0 License.