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

Function: getBmRole()

getBmRole(instance, roleId, options): Promise<{ }>

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

Gets details of a specific access role.

Parameters

instance

B2CInstance

B2C instance to query

roleId

string

Role ID (e.g. "Administrator")

options

GetBmRoleOptions = {}

Expand options

Returns

Promise<{ }>

Role details

Example

const role = await getBmRole(instance, 'Administrator', { expand: ['users'] });
console.log(role.id, role.user_count);