Skip to content

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

Function: listBmRoles() ​

listBmRoles(instance, options): Promise<{ }>

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

Lists all access roles on a B2C Commerce instance.

Parameters ​

instance ​

B2CInstance

B2C instance to query

options ​

ListBmRolesOptions = {}

Pagination options

Returns ​

Promise<{ }>

Roles collection with pagination info

Example ​

typescript
const roles = await listBmRoles(instance);
for (const role of roles.data ?? []) {
  console.log(role.id, role.description);
}

Released under the Apache-2.0 License.