Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.coffeerms.com/llms.txt

Use this file to discover all available pages before exploring further.

​
User API

The User API allows admins and recruiters to manage system users inside the RMS.
All routes are protected with authentication and role-based permissions.

​
Endpoints Overview

MethodRouteDescriptionAccess
GET/api/usersGet all usersuser_management:read OR interview:create
GET/api/users/:idGet single useruser_management:read
POST/api/usersCreate new useruser_management:create
PUT/api/users/:idUpdate useruser_management:update
DELETE/api/users/:idDelete useruser_management:delete

​
GET /api/users

Fetch all system users. 
router.get('/', protect, requireAny([
  { resource: 'user_management', action: 'read' },
  { resource: 'interview', action: 'create' }
]), getUsers);

​

​
GET /api/users

Fetch all system users. 
router.get('/', protect, requireAny([
  { resource: 'user_management', action: 'read' },
  { resource: 'interview', action: 'create' }
]), getUsers);

​
GET /api/users

Fetch all system users. 
router.get('/', protect, requireAny([
  { resource: 'user_management', action: 'read' },
  { resource: 'interview', action: 'create' }
]), getUsers);

​
POST /api/users

Create a new user.
Access: user_management:create 
router.post(
  '/',
  protect,
  requirePermission('user_management', 'create'),
  validateUser,
  createUser
);

​
PUT /api/users/:id

Update an existing user.
Access: user_management:update 
router.put(
  '/:id',
  protect,
  requirePermission('user_management', 'update'),
  updateUser
);

​
DELETE /api/users/:id

Delete a user.
Access: user_management:delete 
router.delete(
  '/:id',
  protect,
  requirePermission('user_management', 'delete'),
  deleteUser
);