Skip to main content
Version: 57.2.0

RoleManager

Properties​

assertCanModifyUser​

assertCanModifyUser: (args) => Promise<void>

Parameters​

args​
actor​

User

userId​

string

Returns​

Promise<void>

assign​

assign: (args) => Promise<void>

Parameters​

args​
actor​

User

roleNames​

string[]

userId​

string

Returns​

Promise<void>

create​

create: (args) => Promise<RbacRoleDocument>

Parameters​

args​
actor​

User

role​

RoleInput

Returns​

Promise<RbacRoleDocument>

list​

list: () => Promise<RbacRoleDocument[]>

Returns​

Promise<RbacRoleDocument[]>

previewAssignment​

previewAssignment: (args) => Promise<UserPermissionDiff>

Parameters​

args​
actor​

User

roleNames​

string[]

userId​

string

Returns​

Promise<UserPermissionDiff>

previewRoleChange​

previewRoleChange: (args) => Promise<RoleDiff>

Parameters​

args​
permissions​

PermissionSet

roleName​

string

Returns​

Promise<RoleDiff>

remove​

remove: (args) => Promise<void>

Parameters​

args​
actor​

User

roleName​

string

Returns​

Promise<void>

seedDefaults​

seedDefaults: () => Promise<void>

Returns​

Promise<void>

unassign​

unassign: (args) => Promise<void>

Parameters​

args​
actor​

User

roleNames​

string[]

userId​

string

Returns​

Promise<void>

update​

update: (args) => Promise<RbacRoleDocument>

Parameters​

args​
actor​

User

changes​

Partial<RoleInput>

roleName​

string

Returns​

Promise<RbacRoleDocument>