Skip to main content

Permissions

Workspace API

Workspace API / models/Permissions

models/Permissions

Functions​

createPermission()​

createPermission(data): Promise<Permission>

Defined in: models/Permissions.ts:12

Create a new permission

Parameters​

data​

CreatePermissionData

Returns​

Promise<Permission>

findByKey()​

findByKey(key): Promise<Permission | null>

Defined in: models/Permissions.ts:26

Find permission by key

Parameters​

key​

string

Returns​

Promise<Permission | null>

findById()​

findById(permissionId): Promise<Permission | null>

Defined in: models/Permissions.ts:35

Find permission by ID

Parameters​

permissionId​

string

Returns​

Promise<Permission | null>

updatePermission()​

updatePermission(permissionId, updateData): Promise<Permission | null>

Defined in: models/Permissions.ts:47

Update permission information

Parameters​

permissionId​

string

updateData​

UpdatePermissionData

Returns​

Promise<Permission | null>

deletePermission()​

deletePermission(permissionId): Promise<boolean>

Defined in: models/Permissions.ts:96

Delete permission

Parameters​

permissionId​

string

Returns​

Promise<boolean>

getPermissions()​

getPermissions(filters): Promise<{ permissions: Permission[]; total: number; }>

Defined in: models/Permissions.ts:107

Get permissions with filters and pagination

Parameters​

filters​

PermissionFilters = {}

Returns​

Promise<{ permissions: Permission[]; total: number; }>

getPermissionsByCategory()​

getPermissionsByCategory(category): Promise<Permission[]>

Defined in: models/Permissions.ts:159

Get permissions by category

Parameters​

category​

string

Returns​

Promise<Permission[]>

getPermissionCategories()​

getPermissionCategories(): Promise<string[]>

Defined in: models/Permissions.ts:173

Get all permission categories

Returns​

Promise<string[]>

isPermissionKeyInUse()​

isPermissionKeyInUse(key, excludeId?): Promise<boolean>

Defined in: models/Permissions.ts:187

Check if permission key exists

Parameters​

key​

string

excludeId?​

string

Returns​

Promise<boolean>

bulkCreatePermissions()​

bulkCreatePermissions(permissions, client?): Promise<Permission[]>

Defined in: models/Permissions.ts:205

Bulk create permissions

Parameters​

permissions​

CreatePermissionData[]

client?​

any

Returns​

Promise<Permission[]>