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

Class: OcapiRolesBackend

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

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.

Implements

• RolesBackend

Constructors

Constructor

new OcapiRolesBackend(instance): OcapiRolesBackend

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:155

Parameters

instance

B2CInstance

Returns

OcapiRolesBackend

Properties

name

readonly name: "ocapi"

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:153

Implementation of

RolesBackend.name

Methods

createRole()

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

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:173

Parameters

roleId

string

input?

CreateRoleInput

Returns

Promise<RoleInfo>

Implementation of

RolesBackend.createRole

---

deleteRole()

deleteRole(roleId): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:178

Parameters

roleId

string

Returns

Promise<void>

Implementation of

RolesBackend.deleteRole

---

getPermissions()

getPermissions(roleId): Promise<{ }>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:182

Parameters

roleId

string

Returns

Promise<{ }>

Implementation of

RolesBackend.getPermissions

---

getRole()

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

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:168

Parameters

roleId

string

options?

expand?

("users" | "permissions")[]

Returns

Promise<RoleInfo>

Implementation of

RolesBackend.getRole

---

grantRole()

grantRole(roleId, login): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:192

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

Parameters

roleId

string

login

string

Returns

Promise<void>

Implementation of

RolesBackend.grantRole

---

listRoles()

listRoles(options): Promise<ListRolesResult>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:157

Parameters

options

ListRolesOptions = {}

Returns

Promise<ListRolesResult>

Implementation of

RolesBackend.listRoles

---

revokeRole()

revokeRole(roleId, login): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:196

Parameters

roleId

string

login

string

Returns

Promise<void>

Implementation of

RolesBackend.revokeRole

---

setPermissions()

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

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:187

Parameters

roleId

string

permissions

Returns

Promise<{ }>

Implementation of

RolesBackend.setPermissions