roles

Workspace API

---

Workspace API / types/roles

types/roles

Interfaces

SystemRole

Defined in: types/roles.ts:2

Properties

role_id

role_id: string

Defined in: types/roles.ts:3

name

name: string

Defined in: types/roles.ts:4

description?

optional description: string

Defined in: types/roles.ts:5

is_default

is_default: boolean

Defined in: types/roles.ts:6

created_at

created_at: Date

Defined in: types/roles.ts:7

updated_at

updated_at: Date

Defined in: types/roles.ts:8

---

OrganizationRole

Defined in: types/roles.ts:11

Extended by

• OrganizationRoleWithPermissions

Properties

role_id

role_id: string

Defined in: types/roles.ts:12

organization_id

organization_id: string

Defined in: types/roles.ts:13

name

name: string

Defined in: types/roles.ts:14

description?

optional description: string

Defined in: types/roles.ts:15

is_active

is_active: boolean

Defined in: types/roles.ts:16

created_by?

optional created_by: string

Defined in: types/roles.ts:17

created_at

created_at: Date

Defined in: types/roles.ts:18

updated_at

updated_at: Date

Defined in: types/roles.ts:19

---

OrganizationRoleWithPermissions

Defined in: types/roles.ts:22

Extends

• OrganizationRole

Properties

role_id

role_id: string

Defined in: types/roles.ts:12

Inherited from

OrganizationRole.role_id

organization_id

organization_id: string

Defined in: types/roles.ts:13

Inherited from

OrganizationRole.organization_id

name

name: string

Defined in: types/roles.ts:14

Inherited from

OrganizationRole.name

description?

optional description: string

Defined in: types/roles.ts:15

Inherited from

OrganizationRole.description

is_active

is_active: boolean

Defined in: types/roles.ts:16

Inherited from

OrganizationRole.is_active

created_by?

optional created_by: string

Defined in: types/roles.ts:17

Inherited from

OrganizationRole.created_by

created_at

created_at: Date

Defined in: types/roles.ts:18

Inherited from

OrganizationRole.created_at

updated_at

updated_at: Date

Defined in: types/roles.ts:19

Inherited from

OrganizationRole.updated_at

permissions

permissions: object[]

Defined in: types/roles.ts:23

permission_id

permission_id: string

key

key: string

name

name: string

category?

optional category: string

---

CreateSystemRoleData

Defined in: types/roles.ts:31

Properties

name

name: string

Defined in: types/roles.ts:32

description?

optional description: string

Defined in: types/roles.ts:33

is_default?

optional is_default: boolean

Defined in: types/roles.ts:34

---

CreateOrganizationRoleData

Defined in: types/roles.ts:37

Properties

organization_id

organization_id: string

Defined in: types/roles.ts:38

name

name: string

Defined in: types/roles.ts:39

description?

optional description: string

Defined in: types/roles.ts:40

created_by?

optional created_by: string

Defined in: types/roles.ts:41

---

UpdateSystemRoleData

Defined in: types/roles.ts:44

Properties

description?

optional description: string

Defined in: types/roles.ts:45

is_default?

optional is_default: boolean

Defined in: types/roles.ts:46

---

UpdateOrganizationRoleData

Defined in: types/roles.ts:49

Properties

name?

optional name: string

Defined in: types/roles.ts:50

description?

optional description: string

Defined in: types/roles.ts:51

is_active?

optional is_active: boolean

Defined in: types/roles.ts:52

---

SystemRoleFilters

Defined in: types/roles.ts:55

Properties

is_default?

optional is_default: boolean

Defined in: types/roles.ts:56

limit?

optional limit: number

Defined in: types/roles.ts:57

offset?

optional offset: number

Defined in: types/roles.ts:58

---

OrganizationRoleFilters

Defined in: types/roles.ts:61

Properties

organization_id

organization_id: string

Defined in: types/roles.ts:62

is_active?

optional is_active: boolean

Defined in: types/roles.ts:63

search?

optional search: string

Defined in: types/roles.ts:64

limit?

optional limit: number

Defined in: types/roles.ts:65

offset?

optional offset: number

Defined in: types/roles.ts:66

---

RolePermissionAssignment

Defined in: types/roles.ts:69

Properties

role_id

role_id: string

Defined in: types/roles.ts:70

permission_id

permission_id: string

Defined in: types/roles.ts:71

created_at

created_at: Date

Defined in: types/roles.ts:72

---

UserRoleAssignment

Defined in: types/roles.ts:75

Extended by

• UserRoleAssignmentWithDetails

Properties

assignment_id

assignment_id: string

Defined in: types/roles.ts:76

user_id

user_id: string

Defined in: types/roles.ts:77

organization_id

organization_id: string

Defined in: types/roles.ts:78

system_role_id?

optional system_role_id: string

Defined in: types/roles.ts:79

custom_role_id?

optional custom_role_id: string

Defined in: types/roles.ts:80

assigned_by?

optional assigned_by: string | null

Defined in: types/roles.ts:81

assigned_at

assigned_at: Date

Defined in: types/roles.ts:82

is_active

is_active: boolean

Defined in: types/roles.ts:83

created_at

created_at: Date

Defined in: types/roles.ts:84

updated_at

updated_at: Date

Defined in: types/roles.ts:85

assignmentId

assignmentId: string

Defined in: types/roles.ts:163

userId

userId: string

Defined in: types/roles.ts:164

organizationId

organizationId: string

Defined in: types/roles.ts:165

systemRoleId?

optional systemRoleId: string

Defined in: types/roles.ts:166

customRoleId?

optional customRoleId: string

Defined in: types/roles.ts:167

assignedBy?

optional assignedBy: string

Defined in: types/roles.ts:168

assignedAt

assignedAt: Date

Defined in: types/roles.ts:169

isActive

isActive: boolean

Defined in: types/roles.ts:170

createdAt

createdAt: Date

Defined in: types/roles.ts:171

updatedAt

updatedAt: Date

Defined in: types/roles.ts:172

---

UserRoleAssignmentWithDetails

Defined in: types/roles.ts:88

Extends

• UserRoleAssignment

Properties

assignment_id

assignment_id: string

Defined in: types/roles.ts:76

Inherited from

UserRoleAssignment.assignment_id

user_id

user_id: string

Defined in: types/roles.ts:77

Inherited from

UserRoleAssignment.user_id

organization_id

organization_id: string

Defined in: types/roles.ts:78

Inherited from

UserRoleAssignment.organization_id

system_role_id?

optional system_role_id: string

Defined in: types/roles.ts:79

Inherited from

UserRoleAssignment.system_role_id

custom_role_id?

optional custom_role_id: string

Defined in: types/roles.ts:80

Inherited from

UserRoleAssignment.custom_role_id

assigned_by?

optional assigned_by: string | null

Defined in: types/roles.ts:81

Inherited from

UserRoleAssignment.assigned_by

assigned_at

assigned_at: Date

Defined in: types/roles.ts:82

Inherited from

UserRoleAssignment.assigned_at

is_active

is_active: boolean

Defined in: types/roles.ts:83

Inherited from

UserRoleAssignment.is_active

created_at

created_at: Date

Defined in: types/roles.ts:84

Inherited from

UserRoleAssignment.created_at

updated_at

updated_at: Date

Defined in: types/roles.ts:85

Inherited from

UserRoleAssignment.updated_at

role_name

role_name: string

Defined in: types/roles.ts:89

role_type

role_type: "system" | "custom"

Defined in: types/roles.ts:90

role_description?

optional role_description: string

Defined in: types/roles.ts:91

assigned_by_name?

optional assigned_by_name: string

Defined in: types/roles.ts:92

assignmentId

assignmentId: string

Defined in: types/roles.ts:163

Inherited from

UserRoleAssignment.assignmentId

userId

userId: string

Defined in: types/roles.ts:164

Inherited from

UserRoleAssignment.userId

organizationId

organizationId: string

Defined in: types/roles.ts:165

Inherited from

UserRoleAssignment.organizationId

systemRoleId?

optional systemRoleId: string

Defined in: types/roles.ts:166

Inherited from

UserRoleAssignment.systemRoleId

customRoleId?

optional customRoleId: string

Defined in: types/roles.ts:167

Inherited from

UserRoleAssignment.customRoleId

assignedBy?

optional assignedBy: string

Defined in: types/roles.ts:168

Inherited from

UserRoleAssignment.assignedBy

assignedAt

assignedAt: Date

Defined in: types/roles.ts:169

Inherited from

UserRoleAssignment.assignedAt

isActive

isActive: boolean

Defined in: types/roles.ts:170

Inherited from

UserRoleAssignment.isActive

createdAt

createdAt: Date

Defined in: types/roles.ts:171

Inherited from

UserRoleAssignment.createdAt

updatedAt

updatedAt: Date

Defined in: types/roles.ts:172

Inherited from

UserRoleAssignment.updatedAt

roleName

roleName: string

Defined in: types/roles.ts:176

roleType

roleType: "system" | "custom"

Defined in: types/roles.ts:177

roleDescription?

optional roleDescription: string

Defined in: types/roles.ts:178

assignedByName?

optional assignedByName: string

Defined in: types/roles.ts:179

---

CreateUserRoleAssignmentData

Defined in: types/roles.ts:95

Properties

user_id

user_id: string

Defined in: types/roles.ts:96

organization_id

organization_id: string

Defined in: types/roles.ts:97

system_role_id?

optional system_role_id: string

Defined in: types/roles.ts:98

custom_role_id?

optional custom_role_id: string

Defined in: types/roles.ts:99

assigned_by?

optional assigned_by: string | null

Defined in: types/roles.ts:100

---

UpdateUserRoleAssignmentData

Defined in: types/roles.ts:103

Properties

system_role_id?

optional system_role_id: string

Defined in: types/roles.ts:104

custom_role_id?

optional custom_role_id: string

Defined in: types/roles.ts:105

is_active?

optional is_active: boolean

Defined in: types/roles.ts:106

---

UserRoleAssignmentFilters

Defined in: types/roles.ts:109

Properties

user_id?

optional user_id: string

Defined in: types/roles.ts:110

organization_id?

optional organization_id: string

Defined in: types/roles.ts:111

role_type?

optional role_type: "system" | "custom"

Defined in: types/roles.ts:112

is_active?

optional is_active: boolean

Defined in: types/roles.ts:113

limit?

optional limit: number

Defined in: types/roles.ts:114

offset?

optional offset: number

Defined in: types/roles.ts:115

---

SystemRoleResponse

Defined in: types/roles.ts:119

Properties

id

id: string

Defined in: types/roles.ts:120

name

name: string

Defined in: types/roles.ts:121

description?

optional description: string

Defined in: types/roles.ts:122

isDefault

isDefault: boolean

Defined in: types/roles.ts:123

createdAt

createdAt: Date

Defined in: types/roles.ts:124

updatedAt

updatedAt: Date

Defined in: types/roles.ts:125

---

OrganizationRoleResponse

Defined in: types/roles.ts:128

Properties

id

id: string

Defined in: types/roles.ts:129

organizationId

organizationId: string

Defined in: types/roles.ts:130

name

name: string

Defined in: types/roles.ts:131

description?

optional description: string

Defined in: types/roles.ts:132

isActive

isActive: boolean

Defined in: types/roles.ts:133

createdBy?

optional createdBy: string

Defined in: types/roles.ts:134

createdAt

createdAt: Date

Defined in: types/roles.ts:135

updatedAt

updatedAt: Date

Defined in: types/roles.ts:136

---

CreateSystemRoleRequest

Defined in: types/roles.ts:139

Properties

name

name: string

Defined in: types/roles.ts:140

description?

optional description: string

Defined in: types/roles.ts:141

isDefault?

optional isDefault: boolean

Defined in: types/roles.ts:142

---

CreateOrganizationRoleRequest

Defined in: types/roles.ts:145

Properties

name

name: string

Defined in: types/roles.ts:146

description?

optional description: string

Defined in: types/roles.ts:147

permissions?

optional permissions: string[]

Defined in: types/roles.ts:148

---

UpdateSystemRoleRequest

Defined in: types/roles.ts:151

Properties

description?

optional description: string

Defined in: types/roles.ts:152

isDefault?

optional isDefault: boolean

Defined in: types/roles.ts:153

---

UpdateOrganizationRoleRequest

Defined in: types/roles.ts:156

Properties

name?

optional name: string

Defined in: types/roles.ts:157

description?

optional description: string

Defined in: types/roles.ts:158

isActive?

optional isActive: boolean

Defined in: types/roles.ts:159

---

AssignSystemRoleRequest

Defined in: types/roles.ts:182

Properties

systemRoleId

systemRoleId: string

Defined in: types/roles.ts:183

---

AssignCustomRoleRequest

Defined in: types/roles.ts:186

Properties

customRoleId

customRoleId: string

Defined in: types/roles.ts:187

---

UserRoleInfo

Defined in: types/roles.ts:190

Properties

roleName

roleName: string

Defined in: types/roles.ts:191

roleType

roleType: "system" | "custom"

Defined in: types/roles.ts:192

roleDescription?

optional roleDescription: string

Defined in: types/roles.ts:193

---

AvailableRoles

Defined in: types/roles.ts:196

Properties

systemRoles

systemRoles: object[]

Defined in: types/roles.ts:197

roleId

roleId: string

name

name: string

description?

optional description: string

isDefault

isDefault: boolean

customRoles

customRoles: object[]

Defined in: types/roles.ts:203

roleId

roleId: string

name

name: string

description?

optional description: string

isActive

isActive: boolean