docs: Mandanten-Suppression API-Übergabe an Controls/CRA-Session

Backend (Suppression-API + Filter) ist live; Frontend-Mark/Unmark (Cyber-Risiko- Projekt + Workspace) wird übergeben. Endpunkte, Integration, offenes Mapping (Anzeige-Entität → control_uuid) dokumentiert. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-16 18:38:58 +02:00
parent 472b0cfd2b
commit 2b5c155f57
1 changed files with 47 additions and 0 deletions
@@ -0,0 +1,47 @@
+# Mandanten-Suppression — API-Übergabe (Backend fertig, UI offen)
+
+**Status (2026-06-16):** Backend **LIVE auf prod + macmini**. Frontend-UI
+(Mark/Unmark) ist **offen** und an die Controls/CRA-Session übergeben.
+
+## Was es tut
+Ein Mandant markiert ein Control als „nicht anwendbar / unbrauchbar" → es wird
+in seinen Use-Case-Ansichten (und künftig Repo-Scans) **ausgeblendet**.
+**Per-Tenant**, **reversibel** (nie gelöscht), **audit-geloggt** (wer/warum/wann).
+Geteilte Schicht für **alle** Surfaces — jede UI ruft dieselbe API mit ihrem
+`X-Tenant-ID`.
+
+## API (backend-compliance)
+Alle Routen: Tenant über Header `X-Tenant-ID` (UUID).
+
+- `GET  /v1/controls/suppressions[?include_reverted=true]`
+  → Liste der Suppressions des Mandanten (Audit: control_uuid, reason, actor,
+  active, created_at, reverted_at/by, control_id, title).
+- `POST /v1/controls/suppressions`  Body: `{"control_uuid": "...", "reason": "...", "actor": "..."}`
+  → markiert als nicht anwendbar (idempotent; reaktiviert eine zurückgenommene).
+- `POST /v1/controls/suppressions/{control_uuid}/revert`  Body: `{"reason": "...", "actor": "..."}`
+  → nimmt zurück (Zeile bleibt für Audit).
+
+## Integration in die Controls-Ansicht
+`GET /v1/controls/use-cases/{use_case}/controls` (atom-grain) berücksichtigt die
+Suppression **nur wenn `X-Tenant-ID` mitgeschickt wird** (Agenten/CRA ohne Tenant
+unberührt):
+- Default: suppressed Controls **ausgeblendet**. `?include_suppressed=true` zeigt sie.
+- Response: `suppressed_count` (Anzahl ausgeblendet im aktuellen Scope) + pro
+  Control ein `suppressed`-Flag (true wenn eingeblendet).
+
+## Zu bauen (Übergabe)
+1. **Cyber-Risikobeurteilungs-Projekt** (admin-compliance): „nicht anwendbar"-Button
+   pro Maßnahme/Control + „X ausgeblendet — anzeigen"-Toggle + Un-Mark.
+   **KLÄREN:** Tragen die dort angezeigten „Maßnahmen" eine `control_uuid` (dann
+   direkt `POST suppressions` mit dieser UUID)? Falls es CRA-M5xx / Findings sind,
+   braucht es ein Mapping Anzeige-Entität → `control_uuid` (oder eine Erweiterung
+   der Suppression auf diese Entität).
+2. **Workspace-Cockpit** (breakpilot-workspace, Anwälte): gleiche API, eigenes Frontend.
+
+## Datenmodell
+Tabelle `compliance.control_suppressions` (Migration 156, FK-los — prod
+`canonical_controls` hatte nach dem DB-Swap keinen PK; mit Migration 157
+wiederhergestellt). PK `(tenant_id, control_uuid)`, `active` + `reverted_*` für
+Reversibilität, `actor`/`reason`/`created_at` für Audit. Geteilter Filter-Helper:
+`compliance.services.control_suppression.suppressed_control_uuids(db, tenant_id)`
+— auch für Repo-Scans nutzbar.