Skip to main content

UserRoleAssignments

Workspace API

Workspace API / models/UserRoleAssignments

models/UserRoleAssignments

Functions​

createUserRoleAssignment()​

createUserRoleAssignment(data): Promise<UserRoleAssignment>

Defined in: models/UserRoleAssignments.ts:13

Create a new user role assignment

Parameters​

data​

CreateUserRoleAssignmentData

Returns​

Promise<UserRoleAssignment>

findByUserAndOrganization()​

findByUserAndOrganization(userId, organizationId): Promise<UserRoleAssignment | null>

Defined in: models/UserRoleAssignments.ts:38

Find user role assignment by user and organization

Parameters​

userId​

string

organizationId​

string

Returns​

Promise<UserRoleAssignment | null>

findById()​

findById(assignmentId): Promise<UserRoleAssignment | null>

Defined in: models/UserRoleAssignments.ts:54

Find user role assignment by ID

Parameters​

assignmentId​

string

Returns​

Promise<UserRoleAssignment | null>

getUserRoleAssignments()​

getUserRoleAssignments(filters): Promise<{ assignments: UserRoleAssignmentWithDetails[]; total: number; }>

Defined in: models/UserRoleAssignments.ts:66

Get user role assignments with details

Parameters​

filters​

UserRoleAssignmentFilters = {}

Returns​

Promise<{ assignments: UserRoleAssignmentWithDetails[]; total: number; }>

updateUserRoleAssignment()​

updateUserRoleAssignment(assignmentId, updateData): Promise<UserRoleAssignment | null>

Defined in: models/UserRoleAssignments.ts:134

Update user role assignment

Parameters​

assignmentId​

string

updateData​

UpdateUserRoleAssignmentData

Returns​

Promise<UserRoleAssignment | null>

updateUserRoleAssignmentByUserAndOrg()​

updateUserRoleAssignmentByUserAndOrg(userId, organizationId, updateData): Promise<UserRoleAssignment | null>

Defined in: models/UserRoleAssignments.ts:178

Update user role assignment by user and organization

Parameters​

userId​

string

organizationId​

string

updateData​

UpdateUserRoleAssignmentData

Returns​

Promise<UserRoleAssignment | null>

deleteUserRoleAssignment()​

deleteUserRoleAssignment(assignmentId): Promise<boolean>

Defined in: models/UserRoleAssignments.ts:223

Delete user role assignment

Parameters​

assignmentId​

string

Returns​

Promise<boolean>

deleteUserRoleAssignmentByUserAndOrg()​

deleteUserRoleAssignmentByUserAndOrg(userId, organizationId): Promise<boolean>

Defined in: models/UserRoleAssignments.ts:235

Delete user role assignment by user and organization

Parameters​

userId​

string

organizationId​

string

Returns​

Promise<boolean>

userHasPermission()​

userHasPermission(userId, organizationId, permissionKey): Promise<boolean>

Defined in: models/UserRoleAssignments.ts:251

Check if user has permission in organization

Parameters​

userId​

string

organizationId​

string

permissionKey​

string

Returns​

Promise<boolean>

getUserPermissions()​

getUserPermissions(userId, organizationId): Promise<object[]>

Defined in: models/UserRoleAssignments.ts:267

Get user's effective permissions in organization

Parameters​

userId​

string

organizationId​

string

Returns​

Promise<object[]>

getUserRoleInOrganization()​

getUserRoleInOrganization(userId, organizationId): Promise<{ role_name: string; role_type: "system" | "custom"; role_description?: string; } | null>

Defined in: models/UserRoleAssignments.ts:288

Get user's role in organization

Parameters​

userId​

string

organizationId​

string

Returns​

Promise<{ role_name: string; role_type: "system" | "custom"; role_description?: string; } | null>

assignSystemRoleToUser()​

assignSystemRoleToUser(userId, organizationId, systemRoleId, assignedBy?, client?): Promise<UserRoleAssignment>

Defined in: models/UserRoleAssignments.ts:320

Assign system role to user in organization

Parameters​

userId​

string

organizationId​

string

systemRoleId​

string

assignedBy?​

string | null

client?​

any

Returns​

Promise<UserRoleAssignment>

assignCustomRoleToUser()​

assignCustomRoleToUser(userId, organizationId, customRoleId, assignedBy?, client?): Promise<UserRoleAssignment>

Defined in: models/UserRoleAssignments.ts:373

Assign custom role to user in organization

Parameters​

userId​

string

organizationId​

string

customRoleId​

string

assignedBy?​

string | null

client?​

any

Returns​

Promise<UserRoleAssignment>