Config

Das Config-Modul ist die zentrale Verwaltung für API-Keys, Nutzerzugänge und Tenant-Stammdaten. Hier werden Zugriffsberechtigungen erteilt, Nutzer eingeladen und grundlegende Einstellungen gepflegt.

API KeysProgrammatischer Zugang mit Scope-Kontrolle

Scope-basiertFeingranulare Berechtigungen pro Key

Tenant-StammdatenFirmenname, Adresse, Steuernummer

Nutzer & RollenEinladen, Rollen vergeben, entfernen

Owner-only für writeSchreibzugriff erfordert Owner-Rolle

Was das Config-Modul abdeckt

API Key-Lifecycle — API Keys erstellen, auflisten und widerrufen. Jeder Key erhält beim Anlegen eine individuelle Scope-Kombination aus den 8 Modulen (journal, bank, debitoren, kreditoren, anlagen, perioden, auswertungen, config). Der Key-Wert wird nur einmalig angezeigt und dann gehasht gespeichert.

Nutzerverwaltung — Owner können weitere Nutzer per E-Mail einladen und ihnen eine Rolle (member oder admin) zuweisen. Bestehende Nutzer lassen sich entfernen. Alle Aktionen werden im Audit-Log festgehalten.

Tenant-Stammdaten — Firmenname, Adresse, Steuernummer, Umsatzsteuer-ID und Rechtsform können hier gepflegt werden. Diese Daten fließen u. a. in Ausgangsrechnungen und ZUGFeRD-Dokumente ein.

OAuth-Clients — Für Drittanbieter-Integrationen können OAuth 2.0 Clients registriert werden. Dies ist ein fortgeschrittenes Feature für Entwickler und Partner.

config:write erfordert Owner-Rolle

Schreibende Operationen im Config-Modul (API Keys erstellen, Nutzer einladen, Tenant-Daten ändern) setzen zusätzlich zur Scope-Berechtigung die Owner-Rolle voraus. Member mit config:write Scope können nur lesend auf Config-Endpunkte zugreifen.

Zugangswege

Dashboard (UI)Der primäre Weg für Config-Aufgaben: API Keys anlegen, Nutzer einladen und Tenant-Daten pflegen — alles in den Einstellungen.

REST APIAPI Keys und Tenant-Daten programmatisch verwalten — z. B. für automatisiertes Onboarding oder Deployment-Skripte.

Wichtige Endpunkte

Methode	Endpoint	Zweck
GET	/v1/api-keys	Alle API Keys auflisten
POST	/v1/api-keys	Neuen API Key erstellen
DELETE	/v1/api-keys/:id	API Key widerrufen
GET	/v1/tenant	Tenant-Stammdaten abrufen
PATCH	/v1/tenant	Tenant-Stammdaten aktualisieren
GET	/v1/users	Alle Nutzer des Tenants auflisten
POST	/v1/users/invite	Nutzer per E-Mail einladen
DELETE	/v1/users/:id	Nutzer entfernen

Scopes

Config-Endpunkte haben keine review-Aktion — nur Lesen und Schreiben:

config:read config:write