@salesforce/b2c-tooling-sdk / operations/users / RevokeRoleOptions

Interface: RevokeRoleOptions

Defined in: packages/b2c-tooling-sdk/src/operations/users/index.ts:117

Options for revoking a role.

See GrantRoleOptions for details on the mixed role ID formats.

Properties

role

role: string

Defined in: packages/b2c-tooling-sdk/src/operations/users/index.ts:121

Role ID as used in the roles array (e.g. 'bm-admin').

---

roleEnumName

roleEnumName: string

Defined in: packages/b2c-tooling-sdk/src/operations/users/index.ts:123

Role enum name as used in roleTenantFilter (e.g. 'ECOM_ADMIN').

---

scope?

optional scope: string

Defined in: packages/b2c-tooling-sdk/src/operations/users/index.ts:125

Optional scope to remove (if not provided, removes entire role)

---

userId

userId: string

Defined in: packages/b2c-tooling-sdk/src/operations/users/index.ts:119

User ID