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

Interface: RolesBackend

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

Common shape of every dual-backend implementation. Each canonical backend (e.g., JobsBackend) extends this so a generic fallback wrapper can read name to know which backend served the last call.

Extends

BackendBase

Properties

name

readonly name: "ocapi" | "scapi"

Defined in: packages/b2c-tooling-sdk/src/clients/scapi-backend-utils.ts:36

Inherited from

BackendBase.name

Methods

createRole()

createRole(roleId, input?): Promise<RoleInfo>

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

Parameters

roleId

string

input?

CreateRoleInput

Returns

Promise<RoleInfo>

deleteRole()

deleteRole(roleId): Promise<void>

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

Parameters

roleId

string

Returns

Promise<void>

getPermissions()

getPermissions(roleId): Promise<{ }>

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

Parameters

roleId

string

Returns

Promise<{ }>

getRole()

getRole(roleId, options?): Promise<RoleInfo>

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

Parameters

roleId

string

options?

expand?

("users" | "permissions")[]

Returns

Promise<RoleInfo>

grantRole()

grantRole(roleId, login): Promise<void>

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

Assigns a user to a role. Returns void; OCAPI returns the user but we don't surface that.

Parameters

roleId

string

Returns

Promise<void>

listRoles()

listRoles(options?): Promise<ListRolesResult>

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

Parameters

options?

ListRolesOptions

Returns

Promise<ListRolesResult>

revokeRole()

revokeRole(roleId, login): Promise<void>

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

Parameters

roleId

string

Returns

Promise<void>

setPermissions()

setPermissions(roleId, permissions): Promise<{ }>

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

Parameters

roleId

string

permissions

Returns

Promise<{ }>