Skip to content

web-backend


Class: RolesController

Defined in: packages/web-backend/src/roles/roles.controller.ts:16

Controller for role and permission management. Secured with JWT; exposes CRUD endpoints for roles.

Constructors

Constructor

new RolesController(rolesService): RolesController

Defined in: packages/web-backend/src/roles/roles.controller.ts:20

Parameters

rolesService

RolesService

Service for roles persistence and queries

Returns

RolesController

Methods

createRole()

createRole(body): Promise<void>

Defined in: packages/web-backend/src/roles/roles.controller.ts:51

Create a new role.

Parameters

body

Role

New role payload including name and permissions.

Returns

Promise<void>

A promise that resolves when the role is created.


getAllRoles()

getAllRoles(query): Promise<Roles[]>

Defined in: packages/web-backend/src/roles/roles.controller.ts:29

List roles with optional ID filtering.

Parameters

query

Optional query with a list of role IDs to include.

id?

string[]

Returns

Promise<Roles[]>

Array of roles matching the filter (or all roles when omitted).


getRoleById()

getRoleById(roleId): Promise<Roles>

Defined in: packages/web-backend/src/roles/roles.controller.ts:40

Retrieve a single role by identifier.

Parameters

roleId

string

Role identifier.

Returns

Promise<Roles>

The role document when found.


removeRole()

removeRole(roleId): Promise<void>

Defined in: packages/web-backend/src/roles/roles.controller.ts:73

Delete a role by identifier.

Parameters

roleId

string

Role identifier.

Returns

Promise<void>

A promise that resolves when the role is removed.


updateRole()

updateRole(body): Promise<void>

Defined in: packages/web-backend/src/roles/roles.controller.ts:62

Update an existing role.

Parameters

body

Role

Role payload including id and fields to update.

Returns

Promise<void>

A promise that resolves when the role is updated.