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

Function: grantBmRole()

grantBmRole(instance, roleId, login): Promise<{ }>

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

Assigns a user to an access role on an instance.

Parameters

instance

B2CInstance

B2C instance

roleId

string

Role ID to grant

login

string

User login (email)

Returns

Promise<{ }>

The user object after assignment

Example

const user = await grantBmRole(instance, 'Administrator', 'user@example.com');