DE 

//Cloudogu EcoSystem Docs

  1. docs.cloudogu.com
  2. Entwicklerdokumentation
  3. Dogus
  4. User Management
  5. Funktionen
  6. CSV IMPORT
Getting Started
Benutzerhandbuch
Entwicklerdokumentation

CSV IMPORT

Aufruf und CSV-Datei Vorgabe

Über den Endpunkt /users/import können Benutzer importiert werden. Als Import-Format wird CSV nach RFC 4180 verwendet. Der Header der Datei muss 7 Spalten definieren:

username,displayname,givenname,surname,mail,pwdReset,external

Die Reihenfolge der Spalten kann variieren, jedoch müssen die Namen der Spalten beibehalten werden.

Die Authentifizierung erfolgt über den Account des eingeloggten Benutzers. Hat dieser keine Admin-Rechte, kann der Endpunkt von dem Nutzer nicht aufgerufen werden. Doppelte Einträge haben keinen Einfluss auf das Ergebnis des Imports, werden jedoch zweifach verarbeitet. Über das Ergebnis des Imports kann festgestellt werden, welcher Eintrag fehlerhaft ist. Über den Import werden aktuell keine Gruppen erstellt oder zugeordnet.

Wie der Import funktioniert.

  • Über den Import können beliebig viele Nutzer angelegt werden.
  • Existiert der Nutzer bereits, werden die Werte in der CSV zum Update verwendet.
  • Aktuell wird jeder angelegte Nutzer als interner Nutzer angesehen.
  • Über den Import kann keine Gruppe erstellt oder zugeordnet werden.

E-Mail Benachrichtung

Bei der Erstellung eines neuen Benutzerkontos erhalten die Benutzer automatisch eine E-Mail mit ihren Anmeldeinformationen, einschließlich Benutzername und temporärem Passwort. Diese E-Mails können individuell konfiguriert werden, wobei Platzhalter wie ${username} und ${password} verwendet werden müssen. Nach dem ersten Login werden die Benutzer aufgefordert, ihr temporäres Passwort zu ändern, um die Sicherheit des Kontos zu gewährleisten.

Ergebnis

Für den Import wird ein Ergebnis-Eintrag angelegt. Dieses Ergebnis ist im Volume importHistory unter /var/lib/usermgt/importHistory zu finden. Das Ergebnis enthält eine Zusammenfassung über die Nutzer, die angelegt oder modifiziert wurden. Ferner enthält das Ergebnis mögliche Fehler, die während des Imports aufgetreten sind. Pro Eintrag wird ein Fehlercode ausgegeben:

Code Fehlerbeschreibung
100 Allgemeiner Fehler, der beim Parsing der CSV Datei aufgetreten ist
101 Wert aus der Spalte, konnte nicht auf Datentypen übertragen werden, z.b. "10" als Boolean
102 Es fehlt ein Spalteneintrag in der Kopfzeile
103 Der Wert der Spalte konnte dem User nicht zugewiesen werden
104 Die Anzahl der Spalten einer Zeilen passen nicht mit denen der Kopfzeile überein
200 Allgemeiner Fehler bei der Validierung der Zeile
201 Der Username ist bereits vergeben
202 Das Format des Wertes stimmt nicht mit dem geforderten Format überein
204 Erforderlicher Wert ist nicht gesetzt
300 Interner Server Fehler
301 Beim Schreiben des Ergebnisses ist ein Fehler aufgetreten

Neben dem Volume können Zusammenfassungen der Imports über den Endpunkt /users/import/summaries abgerufen werden. Einzelne Ergebnisse sind über den Endpunkt /users/import/{importID} verfügbar können über /users/import/{importID}/download heruntergeladen werden.

Vollständig nutzbare CSV-Datei

username,displayname,givenname,surname,mail,pwdReset,external
dent,Arthur Dent,Arthur,Dent,arthur.dent@hitchhiker.com,false,true
trillian,Tricia McMillan,Tricia,McMillan,tricia.mcmillan@hitchhiker.com,false,true