Skip to content

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

Function: deleteBmRole() ​

deleteBmRole(instance, roleId): Promise<void>

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

Deletes an access role from an instance.

System roles (e.g. "Administrator", "Support") cannot be deleted.

Parameters ​

instance ​

B2CInstance

B2C instance

roleId ​

string

Role ID to delete

Returns ​

Promise<void>

Example ​

typescript
await deleteBmRole(instance, 'MyCustomRole');

Released under the Apache-2.0 License.