Files
SnapOtter/apps/docs/de/guide/users-roles.md
T
SnapOtterandGitHub d10d0f544f fix: release QA hardening across processing, media, security, and CI gates (#649)
A release-readiness QA pass over the whole product. The commits split into
defects a user would hit and gates that were reporting green while measuring
nothing.

## Fixes that change behaviour

Rate limiting was bypassable on every install: TRUST_PROXY defaulted to true, so
request.ip came from a client-set header and a forged X-Forwarded-For got past
the login limiter. The default is now a private-network trust list.

A transient Postgres outage stranded in-flight jobs, leaving finished output on
disk with no row pointing at it. A reconciler now resolves those rows and adopts
the bytes rather than dropping the work.

A Redis connection that moved to a new address wedged every read-blocked
consumer, so completions stopped signalling while health still answered 200.
Socket timeouts plus subscriber pings recover it.

Installing more than one AI bundle left the shared venv multi-versioned and
silently broke three tools. The installer now reconciles distributions to one
version each.

Converting an image to JXL at quality 1 through 4 returned a 500, because
libjxl 0.7 rejects the distance those values compute. The quality is floored at
what the encoder honours. A missing ffmpeg was also reported to the user as a
corrupt upload; it now says the engine is unavailable.

RAW uploads reached an unpatched LibRaw on arm64, so it is built from source at
0.22.2, and the release scan was split so it can fail on an unfixed critical
instead of hiding it behind ignore-unfixed.

## Gates that could not fail

Two mutation lanes ran zero mutants because Stryker crawled the gitignored docs
build; coverage discarded its whole report on any failing test; the lint gate
skipped root tests, scripts, and two workspaces; and several generated matrices
counted a host missing ffmpeg as a passing tool. Each now measures what it
claims.

Full evidence and the outstanding release items are tracked locally and are not
part of this branch.
2026-07-27 15:37:30 +08:00

14 KiB

description, i18n_source_hash, i18n_provenance, i18n_output_hash, i18n_hash_version
description i18n_source_hash i18n_provenance i18n_output_hash i18n_hash_version
Verwalte Benutzer, integrierte und benutzerdefinierte Rollen, Berechtigungen, API-Schlüssel, Teams, Sitzungen und das Audit-Log in SnapOtter. bea8955f3aff human d773a75e3981 2

Benutzer, Rollen & Berechtigungen

SnapOtter wird mit drei integrierten Rollen, 17 granularen Berechtigungen und Unterstützung für benutzerdefinierte Rollen mit optionaler Zugriffssteuerung pro Werkzeug ausgeliefert. Diese Seite behandelt das vollständige Autorisierungsmodell, die Bereichseinschränkung von API-Schlüsseln, die Teamverwaltung und das Audit-Logging.

::: tip Verwandte Seiten OIDC / SSO | SAML SSO | SCIM-Bereitstellung | Sicherheit & Härtung :::

Benutzer

Benutzer erstellen

Administratoren können Benutzer über das Admin-Panel oder den POST /api/auth/register-Endpunkt erstellen. Jeder Benutzer hat einen Benutzernamen, eine Rolle, eine Teamzuordnung und eine optionale E-Mail-Adresse.

Standard-Administrator

Beim ersten Start erstellt SnapOtter ein Standard-Administratorkonto. Die Zugangsdaten stammen aus Umgebungsvariablen:

Variable Standard Beschreibung
DEFAULT_USERNAME admin Benutzername für das anfängliche Administratorkonto
DEFAULT_PASSWORD admin Passwort für das anfängliche Administratorkonto

Der Standard-Administrator muss beim ersten Login sein Passwort ändern.

Authentifizierungsanbieter

Benutzer können sich über mehrere Methoden authentifizieren:

  • Lokal - Benutzername und Passwort, gespeichert in der SnapOtter-Datenbank
  • OIDC - jeder OpenID-Connect-Anbieter (siehe OIDC / SSO)
  • SAML - SAML-2.0-Identitätsanbieter (siehe SAML SSO)
  • SCIM - automatisierte Bereitstellung durch einen Identitätsanbieter (siehe SCIM-Bereitstellung)

Authentifizierung deaktivieren

Setze AUTH_ENABLED=false, um die Authentifizierung vollständig zu deaktivieren. In diesem Modus wird für alle Anfragen ein synthetischer anonymer Benutzer mit der Rolle admin verwendet. Es ist kein Login erforderlich.

::: warning Das Deaktivieren der Authentifizierung gewährt jedem, der die Instanz erreichen kann, vollen Administratorzugriff. Verwende dies nur in vertrauenswürdigen Umgebungen. :::

Integrierte Rollen

SnapOtter enthält drei integrierte Rollen. Sie können weder geändert noch gelöscht werden.

Admin

Alle 17 Berechtigungen. Volle Kontrolle über die Instanz.

tools:use files:own files:all apikeys:own apikeys:all pipelines:own pipelines:all settings:read settings:write users:manage teams:manage features:manage system:health audit:read compliance:manage webhooks:manage security:manage

Editor

7 Berechtigungen. Kann alle Werkzeuge verwenden und alle Dateien und Pipelines verwalten, aber nicht auf Administratorfunktionen zugreifen.

tools:use files:own files:all apikeys:own pipelines:own pipelines:all settings:read

User

5 Berechtigungen. Kann Werkzeuge verwenden und eigene Ressourcen verwalten.

tools:use files:own apikeys:own pipelines:own settings:read

Berechtigungsreferenz

Berechtigung Beschreibung
tools:use Jedes Verarbeitungswerkzeug verwenden
files:own Eigene Dateien ansehen und verwalten
files:all Dateien aller Benutzer ansehen und verwalten
apikeys:own Eigene API-Schlüssel erstellen und verwalten
apikeys:all API-Schlüssel aller Benutzer ansehen
pipelines:own Eigene Pipelines erstellen und verwalten
pipelines:all Pipelines aller Benutzer ansehen und verwalten
settings:read Instanzeinstellungen ansehen
settings:write Instanzeinstellungen ändern
users:manage Erstellen und verwalten Sie Benutzerkonten innerhalb der Autoritätsgrenzen des Akteurs
teams:manage Teams erstellen, aktualisieren und löschen
features:manage KI-Feature-Bundles installieren und verwalten
system:health Auf Health- und Readiness-Endpunkte zugreifen
audit:read Das Audit-Log ansehen und Rollen auflisten
compliance:manage Verwalten Sie den DSGVO-Lebenszyklus und die Compliance-Funktionen. Zerstörerische Benutzeroperationen bleiben autoritätsgebunden
webhooks:manage Ausgehende Webhooks konfigurieren
security:manage Sicherheitseinstellungen verwalten (IP-Zulassungsliste, SSO-Erzwingung)

Benutzerdefinierte Rollen

Administratoren mit der Berechtigung security:manage können benutzerdefinierte Rollen über das Admin-Panel oder die Rollen-API erstellen. Das Auflisten von Rollen erfordert audit:read.

Eine benutzerdefinierte Rolle erstellen

curl -X POST http://localhost:1349/api/v1/roles \
  -H "Authorization: Bearer si_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "reviewer",
    "description": "Can use tools and view all files",
    "permissions": ["tools:use", "files:own", "files:all", "settings:read"]
  }'

Rollennamen müssen 2 bis 30 Zeichen lang sein, kleingeschrieben alphanumerisch mit Bindestrichen und Unterstrichen.

Delegierte Verwaltungsgrenzen

Alle 17 Berechtigungen können über benutzerdefinierte Rollen delegiert werden, aber eine Administratorberechtigung macht diese Rolle nicht gleichwertig mit der integrierten admin-Rolle. Von users:manage autorisierte Benutzermutationen, von compliance:manage autorisierte destruktive Operationen und von security:manage autorisierte benutzerdefinierte Rollenverwaltung unterliegen den aktuellen Berechtigungen des Akteurs:

  • Integrierte Rollen folgen admin > editor > user; Benutzerdefinierte Rollen sind unterhalb der integrierten Rollen aufgeführt.
  • Die Berechtigungen des Ziels müssen in den wirksamen Berechtigungen des Akteurs enthalten sein. Ein bereichsbezogener API-Schlüssel kann daher keine Berechtigungen ausüben, die in seinem Bereich fehlen.
  • Der Tool-Zugriff einer Zielrolle muss durch den eigenen Tool-Zugriff des Akteurs begrenzt sein.
  • Ein deaktiviertes Konto wird mit seiner ursprünglichen Rolle verglichen, wenn diese Rolle als disabled:<original-role> aufgezeichnet ist.
  • Zum Löschen einer benutzerdefinierten Rolle ist außerdem die Berechtigung zum Zuweisen des integrierten user-Fallbacks erforderlich. deaktivierte Mitglieder bleiben als disabled:user deaktiviert.

Globale Anmeldeinformationen und Konfiguration sind strenger: Das Ausstellen oder Widerrufen des SCIM-Tokens und das Importieren der Instanzkonfiguration erfordern die integrierte admin-Rolle mit vollständiger effektiver Administratorberechtigung.

Berechtigungen auf Werkzeugebene

Benutzerdefinierte Rollen können optional einschränken, auf welche Werkzeuge Benutzer zugreifen dürfen. Zwei Modi sind verfügbar:

Modus Verhalten Lizenzanforderung
category Einschränkung nach Modalität (Bild, Video, Audio, Dokument, Datei) Keine (kostenlos)
tool Einschränkung nach einzelner Werkzeug-ID Erfordert das Enterprise-Feature per_tool_permissions

Wenn der Modus tool gesetzt ist, das Enterprise-Feature aber nicht verfügbar ist, degradiert SnapOtter kontrolliert und erlaubt den Zugriff auf alle Werkzeuge.

{
  "name": "image-only",
  "permissions": ["tools:use", "files:own"],
  "toolPermissions": {
    "mode": "category",
    "allowed": ["image"]
  }
}

Eine benutzerdefinierte Rolle löschen

Wenn eine benutzerdefinierte Rolle gelöscht wird, werden alle ihr zugewiesenen Benutzer automatisch der Rolle user neu zugewiesen.

Teams

Teams gruppieren Benutzer für die Speicher- und Aufbewahrungsverwaltung. Ein Default-Team wird beim ersten Start erstellt.

Feld Typ Beschreibung
name string Eindeutiger Teamname (1 bis 50 Zeichen)
storageQuota number Speicherlimit pro Team in Bytes (funktioniert ohne Enterprise)
retentionHours number Ausgaben nach dieser Anzahl von Stunden automatisch löschen (erfordert team_retention_overrides, Enterprise)
legalHold boolean Automatisches Löschen der Dateien von Teammitgliedern verhindern (erfordert legal_hold, Enterprise)

::: info Das Default-Team kann nicht gelöscht werden. Teams, die noch Mitglieder haben, können nicht gelöscht werden. Weise die Mitglieder zuerst neu zu. :::

API-Schlüssel

Benutzer können API-Schlüssel für programmatischen Zugriff generieren. Jeder Schlüssel verwendet das Präfix si_ und wird nur einmal bei der Erstellung angezeigt.

Bereichseingeschränkte Berechtigungen

API-Schlüssel können optional ein permissions-Array tragen. Wenn gesetzt, sind die effektiven Berechtigungen für eine Anfrage die Schnittmenge der Rollenberechtigungen des Benutzers und der bereichseingeschränkten Berechtigungen des Schlüssels. Das bedeutet, ein API-Schlüssel kann nie über die eigenen Berechtigungen des Benutzers hinaus eskalieren.

curl -X POST http://localhost:1349/api/v1/api-keys \
  -H "Authorization: Bearer si_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "CI pipeline key",
    "permissions": ["tools:use", "files:own"],
    "expiresAt": "2027-01-01T00:00:00Z"
  }'

Ablauf

Schlüssel akzeptieren einen optionalen expiresAt-Zeitstempel. Abgelaufene Schlüssel werden bei der Authentifizierung abgewiesen.

Audit-Log

SnapOtter zeichnet sicherheitsrelevante Ereignisse in einem strukturierten Audit-Log auf, das in der Datenbanktabelle audit_log gespeichert wird.

Das Audit-Log ansehen

GET /api/v1/audit-log?page=1&limit=50&action=LOGIN_FAILED&from=2026-01-01T00:00:00Z&to=2026-12-31T23:59:59Z

Erfordert die Berechtigung audit:read. Unterstützt Seitennummerierung (page, limit) und Filter (action, ip, from, to).

Auditing von Werkzeugoperationen

::: warning TOOL_EXECUTED-Ereignisse werden standardmäßig nicht protokolliert. Sie sind über einen von zwei Wegen aktivierbar (Opt-in):

  1. Setze die Admin-Einstellung auditToolOperations auf true.
  2. Halte eine aktive Lizenz mit dem Feature audit_export (verfügbar sowohl in den Team- als auch in den Enterprise-Tarifen).

Ohne eine dieser Optionen werden einzelne Werkzeugausführungen nicht im Audit-Log erfasst. :::

Exportieren

GET /api/v1/enterprise/audit/export?format=csv&from=2026-01-01T00:00:00Z

Erfordert die Berechtigung audit:read und das Enterprise-Feature audit_export (verfügbar sowohl in den Team- als auch in den Enterprise-Tarifen). Unterstützt die Formate CSV und JSON, gefiltert nach action, actorId, targetType, targetId, from und to.

Manipulationssichere Signierung

Wenn aktiviert, wird jeder Audit-Log-Eintrag mit einem HMAC signiert, der aus DATA_ENCRYPTION_KEY abgeleitet wird. Dies erfordert:

  1. Das Setzen von DATA_ENCRYPTION_KEY in deiner Umgebung.
  2. Das Aktivieren der Admin-Einstellung tamperResistantAudit.
  3. Eine Enterprise-Lizenz mit dem Feature tamper_resistant_audit.

Aufbewahrung

Setze AUDIT_RETENTION_DAYS, um alte Einträge automatisch zu bereinigen. Der Standard ist 0, was bedeutet, dass Einträge unbegrenzt aufbewahrt werden.

Ereignisreferenz

Ereignis Kategorie
LOGIN_SUCCESS, LOGIN_FAILED Authentifizierung
OIDC_LOGIN_SUCCESS, OIDC_LOGIN_FAILED Authentifizierung
SAML_LOGIN_SUCCESS, SAML_LOGIN_FAILED Authentifizierung
LOGOUT Authentifizierung
USER_CREATED, USER_UPDATED, USER_DELETED Benutzerverwaltung
PASSWORD_CHANGED, PASSWORD_RESET Benutzerverwaltung
MFA_ENROLLED, MFA_DISABLED, MFA_VERIFIED, MFA_VERIFY_FAILED MFA
MFA_CHALLENGE_ISSUED, MFA_RECOVERY_USED, MFA_RESET MFA
ROLE_CREATED, ROLE_UPDATED, ROLE_DELETED Rollen
API_KEY_CREATED, API_KEY_DELETED API-Schlüssel
SETTINGS_UPDATED, IP_ALLOWLIST_UPDATED Einstellungen
FILE_UPLOADED, FILE_DELETED Dateien
TOOL_EXECUTED Werkzeuge (Opt-in)
SCIM_USER_PROVISIONED, SCIM_USER_UPDATED, SCIM_USER_DEPROVISIONED SCIM
SCIM_GROUP_SYNCED SCIM
LEGAL_HOLD_APPLIED, LEGAL_HOLD_RELEASED Compliance
GDPR_EXPORT_INITIATED, GDPR_USER_PURGED, GDPR_TEAM_PURGED Compliance
CONFIG_EXPORTED, CONFIG_IMPORTED Konfiguration

Sitzungsverwaltung

Sitzungen sind cookiebasiert und werden über SESSION_DURATION_HOURS gesteuert (Standard: 168 Stunden / 7 Tage).

Rollenänderungen machen Sitzungen ungültig

Wenn ein Administrator die Rolle eines Benutzers ändert, werden alle aktiven Sitzungen dieses Benutzers gelöscht. Der Benutzer muss sich erneut anmelden, um seine neuen Berechtigungen zu übernehmen.

Schutzmechanismen

  • Schutz des letzten Administrators: Der letzte verbleibende Administrator kann nicht auf eine niedrigere Rolle herabgestuft werden. Die API gibt einen Fehler zurück, wenn du es versuchst.
  • Selbstlöschungsschutz: Administratoren können ihr eigenes Konto nicht über die API löschen.