Authentifizierung
docuteam box hat zwei verschiedene Authifizierungsmechanismen, einen für das User Interface und einen für die API.
User Interface
Die Authentifizierung für das User Interface wir über eine Keycloak Instanz verwaltet. Benutzer werden entweder direkt in dieser Instanz oder über einem externen Identitätsprovider mittels OpenID Connect oder SAML2.0 (z.B. AzureAD) verwaltet.
Die folgende Tabelle enthält die verfügbaren Rollen und die damit verbundenen Berechtigungen.
| Rolle | einfache Suche | Record Resources editieren | Cockpit anzeigen | SPARQL Suche | API keys | Webhooks | Tasks | Features | Einstellungen | Maintenance |
|---|---|---|---|---|---|---|---|---|---|---|
| admin | X (alle Namespaces) | - | X (alle Namespaces) | - | X | X | X (alle) | X | X | X |
| <namespace>@user | X (nur <namespace>) | - | X (nur <namespace>) | - | - | - | X (eigene) | - | - | - |
| <namespace>@editor_metadata | - | X (nur <namespace>) | - | - | - | - | - | - | - | - |
| sparql_query | - | - | - | X | - | - | - | - | - | - |
API
Requests an die API werden mit einem X-Auth-Token-Header authentifiziert.
Die Token selber werden durch das User Interface verwaltet:
Jeder API-Key hat die folgenden Felder bzw. Werte:
| Feld | |
|---|---|
label | kann frei gewählt werden, um den Gebrauch/Kontext des Tokens zu beschreiben |
token | wird bei der Erstellung eines neuen API-Keys neu generiert |
role | entweder Read,Query oder Manage |
Read | möglicher Wert von role; erlaubt Zugriff auf spezifische Endpunkte, z.B. Zugriff auf Previews, Originale oder ganze DIPs |
Query | erlaubt die übergreifende Suche im Repository mit dem triplestore |
Manage | erlaubt das Ändern von Daten in Fedora durch die insert und replace API |
