Skip to content

Notifications — permissions

Scaffolded stub — replace with proper documentation when this module is next touched.

Returned by NotificationsModule.get_permissions() (relative names; the registry namespaces them as notifications.<name>).

PermissionAllowsRequired by
notifications.templates.readDescribe what this allows.List the endpoints.
notifications.templates.writeDescribe what this allows.List the endpoints.
notifications.preferences.readDescribe what this allows.List the endpoints.
notifications.preferences.writeDescribe what this allows.List the endpoints.
notifications.logs.readDescribe what this allows.List the endpoints.
notifications.sendDescribe what this allows.List the endpoints.
notifications.settings.readDescribe what this allows.List the endpoints.
notifications.settings.writeDescribe what this allows.List the endpoints.

Role assignment

See backend/app/core/auth/permissions.py for the canonical role table.

Adding a new permission

  1. Add the relative name to get_permissions() in backend/app/modules/notifications/__init__.py (or module.py).
  2. Add the namespaced form to the relevant role(s) in backend/app/core/auth/permissions.py.
  3. Add a row to the table above.
  4. Annotate the endpoint(s) with Depends(require_permission(...)).
  5. Update frontend/app/config/permissions.ts if it gates UI.