Admins Router
This router manages the admin list for an organization. It provides endpoints to:
- Get the current admin list UID for the organization
- Set/update the admin list for the organization
The admin functionality works by linking a specific list (which contains admin users)
to the organization via a 'admin' type link in the Links table.
All endpoints require admin rights to access.
- Source:
module:AdminsRouter
Export the admin router
This router provides a simple but essential functionality for managing
organizational administration. The admin list system works as follows:
1. Each organization can have one admin list
2. The admin list is a regular list object that contains admin users
3. The connection between organization and admin list is stored in the Links table
4. Link type 'admin' identifies admin list relationships
Database Schema:
- Links.UID: Points to the admin list UID
- Links.UIDTarget: Points to the organization root UID
- Links.Type: Set to 'admin' to identify admin relationships
Security:
- All endpoints require existing admin rights (checkAdmin middleware)
- This prevents unauthorized users from viewing or modifying admin lists
- Request logging ensures admin list changes are tracked
- Source:
Methods
(async, inner) getAdminList()
Parameters:
| Type | Description |
|---|---|
- Source:
(async, inner) setAdminList()
Parameters:
| Type | Description |
|---|---|
- Source: