Skip to main content

permissionHelper

Workspace API


Workspace API / helpers/permissionHelper

helpers/permissionHelper

Functions

requirePermission()

requirePermission(permissionKey): (request, reply) => Promise<undefined>

Defined in: helpers/permissionHelper.ts:14

Middleware to require specific permission in organization

Parameters

permissionKey

string

Returns

(request, reply): Promise<undefined>

Parameters
request

FastifyRequest

reply

FastifyReply

Returns

Promise<undefined>


checkPermission()

checkPermission(request, organizationId, permissionKey): Promise<boolean>

Defined in: helpers/permissionHelper.ts:67

Check if current user has specific permission in organization (returns boolean)

Parameters

request

FastifyRequest

organizationId

string

permissionKey

string

Returns

Promise<boolean>


getUserPermissionsInOrganization()

getUserPermissionsInOrganization(request, organizationId): Promise<object[]>

Defined in: helpers/permissionHelper.ts:89

Get user's permissions in organization

Parameters

request

FastifyRequest

organizationId

string

Returns

Promise<object[]>


getUserRoleInfoInOrganization()

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

Defined in: helpers/permissionHelper.ts:112

Get user's role information in organization

Parameters

request

FastifyRequest

organizationId

string

Returns

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


requireOrganizationAdmin()

requireOrganizationAdmin(request, reply): Promise<undefined>

Defined in: helpers/permissionHelper.ts:137

Middleware to require organization admin access (using new permission system)

Parameters

request

FastifyRequest

reply

FastifyReply

Returns

Promise<undefined>


checkOrganizationAdmin()

checkOrganizationAdmin(request, organizationId): Promise<boolean>

Defined in: helpers/permissionHelper.ts:189

Check if current user is organization admin (returns boolean)

Parameters

request

FastifyRequest

organizationId

string

Returns

Promise<boolean>


requireAnyPermission()

requireAnyPermission(permissionKeys): (request, reply) => Promise<undefined>

Defined in: helpers/permissionHelper.ts:211

Middleware to require any of the specified permissions

Parameters

permissionKeys

string[]

Returns

(request, reply): Promise<undefined>

Parameters
request

FastifyRequest

reply

FastifyReply

Returns

Promise<undefined>


requireAllPermissions()

requireAllPermissions(permissionKeys): (request, reply) => Promise<undefined>

Defined in: helpers/permissionHelper.ts:269

Middleware to require all of the specified permissions

Parameters

permissionKeys

string[]

Returns

(request, reply): Promise<undefined>

Parameters
request

FastifyRequest

reply

FastifyReply

Returns

Promise<undefined>