Benutzerimport & -export
Auris bietet Massenimport- und -exportwerkzeuge für Benutzerdaten. Importiere Benutzer aus CSV- oder JSON-Dateien bei der Migration von einem anderen Identitätsanbieter, dem Onboarding einer neuen Abteilung oder dem Befüllen einer Staging-Umgebung. Exportiere deine Benutzerdatenbank für Backups, Compliance-Audits oder die Migration zu einem anderen System.
Zugriff über Konsole → Einstellungen → Import / Export.
Benutzer importieren
Der Importfluss führt dich durch Datei-Upload, Datenvorschau und Verarbeitung. Importe laufen asynchron — du kannst die Seite verlassen und den Fortschritt später überprüfen.
Import-Walkthrough
Auf Benutzer importieren klicken
Klicke auf der Import/Export-Seite auf die Schaltfläche Benutzer importieren im Import-Bereich.
Dateiformat auswählen
Wähle CSV oder JSON. Dies teilt Auris mit, wie die hochzuladende Datei geparst werden soll.
Datei hochladen
Ziehe eine Datei per Drag-and-Drop in den Upload-Bereich, oder klicke auf Durchsuchen, um eine Datei von deinem Computer auszuwählen. Die maximale Dateigröße beträgt 10 MB.
Die geparsten Daten in der Vorschau anzeigen
Auris parst die Datei und zeigt die ersten 10 Zeilen in einer Vorschautabelle an. Überprüfe, ob Spaltenüberschriften korrekt erkannt werden und Werte in den richtigen Feldern erscheinen. Wenn die Vorschau falsch aussieht, prüfe dein Dateiformat anhand der nachstehenden Anforderungen.
Spalten den Auris-Feldern zuordnen
Wenn deine Datei nicht standardmäßige Spaltennamen verwendet, ordne jede Spalte dem entsprechenden Auris-Feld zu:
| Auris-Feld | Erforderlich | Beschreibung |
|---|---|---|
email | Ja | Die E-Mail-Adresse des Benutzers. Muss ein gültiges E-Mail-Format haben. Muss im Tenant eindeutig sein. |
firstName | Nein | Vorname |
lastName | Nein | Nachname |
username | Nein | Benutzername. Wenn nicht angegeben, leitet Auris ihn aus der E-Mail-Adresse ab. |
password | Nein | Klartext-Passwort. Wird (bcrypt) vor der Speicherung gehasht. Wenn nicht angegeben, muss der Benutzer “Passwort vergessen” oder Magic Link zum Setzen eines Passworts verwenden. |
roles | Nein | Kommagetrennte Liste von Rollennamen, die zugewiesen werden sollen. Rollen müssen bereits im Tenant existieren. |
Auf Import starten klicken
Klicke auf Import starten, um die Verarbeitung zu beginnen. Der Import läuft im Hintergrund.
Dateiformatanforderungen
CSV-Format
Die erste Zeile muss eine Kopfzeile mit Spaltennamen sein. Werte mit Kommas müssen in Anführungszeichen gesetzt werden. Mehrwertige Felder (wie Rollen) sollten in Anführungszeichen gesetzt und kommagetrennt innerhalb der Anführungszeichen sein.
email,firstName,lastName,password,roles
[email protected],Alice,Smith,SecureP@ss123,editor
[email protected],Bob,Jones,AnotherP@ss456,"editor,viewer"
[email protected],Carol,Williams,,viewerIm obigen Beispiel hat Carol kein Passwort — sie muss “Passwort vergessen” oder Magic Link verwenden, um eines zu setzen.
JSON-Format
Die Datei muss ein JSON-Array von Benutzerobjekten enthalten. Jedes Objekt folgt derselben Feldstruktur wie die CSV-Spalten.
[
{
"email": "[email protected]",
"firstName": "Alice",
"lastName": "Smith",
"password": "SecureP@ss123",
"roles": ["editor"]
},
{
"email": "[email protected]",
"firstName": "Bob",
"lastName": "Jones",
"password": "AnotherP@ss456",
"roles": ["editor", "viewer"]
},
{
"email": "[email protected]",
"firstName": "Carol",
"lastName": "Williams",
"roles": ["viewer"]
}
]Passwörter in Importdateien werden vor der Speicherung gehasht (bcrypt). Sie werden niemals im Klartext gespeichert oder protokolliert. Mit Passwörtern importierte Benutzer können sich sofort anmelden. Ohne Passwörter importierte Benutzer müssen den Passwort vergessen-Fluss oder Magic Links zum Erstellen von Anmeldedaten verwenden.
Importverarbeitung
Nach dem Klicken auf “Import starten” läuft der Import asynchron. Jede Zeile wird sequenziell verarbeitet:
- Die E-Mail wird auf Format und Eindeutigkeit validiert
- Wenn ein Passwort angegeben ist, wird es mit bcrypt gehasht
- Der Benutzer wird in Prisma (Auris-Datenbank) erstellt
- Der Benutzer wird in Keycloak (Authentifizierungs-Backend) erstellt
- Wenn Rollen angegeben sind, wird der Benutzer diesen Rollen zugewiesen
- Der Importfortschrittszähler erhöht sich
Importhistorie
Der Import-Bereich zeigt eine Historientabelle aller Importjobs:
| Spalte | Beschreibung |
|---|---|
| Dateiname | Name der hochgeladenen Datei |
| Format | CSV oder JSON |
| Status | Aktueller Status (siehe unten) |
| Gesamtzeilen | Anzahl der Benutzerdatensätze in der Datei |
| Erfolgreich | Anzahl der erfolgreich importierten Benutzer |
| Fehler | Anzahl der fehlgeschlagenen Zeilen |
| Datum | Wann der Import gestartet wurde |
Importstatus
| Status | Bedeutung |
|---|---|
| Ausstehend | Der Import ist in der Warteschlange, aber noch nicht verarbeitet |
| Verarbeitung | Der Import läuft aktiv. Ein Fortschrittsbalken zeigt X von Y verarbeiteten Benutzern. |
| Abgeschlossen | Alle Zeilen wurden erfolgreich ohne Fehler verarbeitet |
| Teilweise | Die Verarbeitung ist beendet, aber einige Zeilen sind fehlgeschlagen. Klicke für Fehlerdetails. |
| Fehlgeschlagen | Der Import konnte überhaupt nicht verarbeitet werden (z. B. Datei ist fehlerhaft oder Keycloak ist nicht erreichbar) |
Fehlerdetails anzeigen
Klicke auf einen Import mit dem Status Teilweise oder Fehlgeschlagen, um zeilenspezifische Fehlerdetails anzuzeigen:
| Spalte | Beschreibung |
|---|---|
| Zeilennummer | Welche Zeile in der Datei fehlgeschlagen ist |
| Die E-Mail-Adresse aus dieser Zeile | |
| Fehler | Was schiefgelaufen ist |
Häufige zeilenspezifische Fehler:
| Fehler | Ursache |
|---|---|
| E-Mail bereits vorhanden | Ein Benutzer mit dieser E-Mail ist bereits im Tenant |
| Ungültiges E-Mail-Format | Die E-Mail-Adresse hat kein gültiges Format |
| Rolle nicht gefunden: “admin” | Die angegebene Rolle existiert nicht im Tenant |
| Keycloak-Fehler | Keycloak hat die Benutzererstellung abgelehnt (Keycloak-Protokolle für Details prüfen) |
| Pflichtfeld fehlt: email | Die E-Mail-Spalte ist für diese Zeile leer |
Importe erstellen Benutzer in sowohl Prisma als auch Keycloak. Wenn Keycloak während des Imports nicht erreichbar ist, schlagen betroffene Zeilen fehl. Die erfolgreich importierten Zeilen (bereits in beiden Systemen) werden nicht zurückgerollt. Führe den Import erneut aus, nachdem Keycloak wiederhergestellt ist — vorhandene Benutzer werden mit einem Fehler “E-Mail bereits vorhanden” übersprungen, und nur die zuvor fehlgeschlagenen Zeilen werden erstellt.
Benutzer exportieren
Exportiere deine Benutzerdatenbank in eine CSV- oder JSON-Datei für Backup, Migration oder Compliance-Zwecke.
Export-Walkthrough
Auf Benutzer exportieren klicken
Klicke auf der Import/Export-Seite auf die Schaltfläche Benutzer exportieren im Export-Bereich.
Das Exportformat auswählen
Wähle CSV oder JSON.
Auf Export starten klicken
Klicke auf Export starten. Der Export läuft im Hintergrund.
Die Datei herunterladen
Wenn der Export abgeschlossen ist, erscheint eine Herunterladen-Schaltfläche in der Exporthistorientabelle. Klicke darauf, um die Datei herunterzuladen.
Exportierte Felder
Der Export enthält die folgenden Felder für jeden Benutzer:
| Feld | Beschreibung |
|---|---|
email | Die E-Mail-Adresse des Benutzers |
firstName | Vorname |
lastName | Nachname |
username | Benutzername |
roles | Kommagetrennte Liste der zugewiesenen Rollennamen |
enabled | Ob das Konto aktiv ist (true / false) |
createdAt | Kontoerstellungszeitstempel (ISO 8601) |
lastLoginAt | Letzter Anmeldezeitstempel (ISO 8601) oder leer, wenn der Benutzer sich noch nie angemeldet hat |
Passwörter sind niemals in Exporten enthalten. Dies ist eine bewusste Sicherheitsmaßnahme. Wenn du Benutzer zu einem anderen System migrieren musst, müssen Benutzer ihre Passwörter im neuen System zurücksetzen.
Exporthistorie
Der Export-Bereich zeigt eine Historientabelle aller Exportjobs:
| Spalte | Beschreibung |
|---|---|
| Format | CSV oder JSON |
| Status | Ausstehend, Verarbeitung, Abgeschlossen oder Fehlgeschlagen |
| Gesamtbenutzer | Anzahl der im Export enthaltenen Benutzer |
| Dateigröße | Größe der generierten Datei |
| Läuft ab am | Wann der Download-Link abläuft (24 Stunden nach Fertigstellung) |
| Datum | Wann der Export gestartet wurde |
| Aktionen | Herunterladen-Schaltfläche (verfügbar wenn Status Abgeschlossen und Datei nicht abgelaufen) |
Exportdateien werden 24 Stunden nach der Generierung automatisch gelöscht. Wenn du die Datei nach Ablauf benötigst, führe einen neuen Export aus.
API-Referenz
Import- und Exportoperationen sind auch über die REST-API für Automatisierung und CI/CD-Pipelines verfügbar.
/api/users/import//api/users/import//api/users/import/:id/api/users/export//api/users/export//api/users/export/:id/downloadBest Practices
-
Zuerst mit einer kleinen Datei testen. Bevor du 10.000 Benutzer importierst, versuche eine Datei mit 5-10 Benutzern, um zu überprüfen, ob deine Spaltenzuordnung und Rollennamen korrekt sind.
-
Rollen vorab erstellen. Der Import erstellt keine Rollen spontan. Alle in der Importdatei referenzierten Rollennamen müssen bereits in Konsole → Rollen existieren.
-
Konsistente E-Mail-Formatierung verwenden. Auris behandelt E-Mail-Adressen als Groß-/Kleinschreibung-unempfindlich, aber die ursprüngliche Schreibweise wird beibehalten. Vermeide das Mischen von
[email protected]und[email protected]in derselben Datei. -
Große Importe außerhalb der Stoßzeiten planen. Jeder importierte Benutzer löst einen Keycloak-API-Aufruf aus. Für Importe mit Tausenden von Benutzern erzeugt dies eine erhebliche Last auf Keycloak.
-
Exportdateien sicher aufbewahren. Obwohl Exporte keine Passwörter enthalten, enthalten sie E-Mail-Adressen, Namen und Rollenzuweisungen. Behandle Exportdateien als sensible Daten.
Berechtigungen
| Berechtigung | Beschreibung |
|---|---|
manage:users | Erforderlich für das Importieren und Exportieren von Benutzern. Dies ist dieselbe Berechtigung, die für das Erstellen und Verwalten von Benutzern über die Konsolen-UI verwendet wird. |
Zugehörige Anleitungen
- Benutzer verwalten — Einzelne Benutzer in der Konsole erstellen und verwalten
- Benutzerimport & -export Anleitung — Detaillierte Entwickleranleitung mit Skript-Beispielen
- Benutzer & Rollen — Benutzer- und Rollenverwaltung in der Konsole
- SCIM-Provisionierung — Automatisierte Provisionierung von Enterprise-IdPs als Alternative zum manuellen Import