Skip to content

Functions UserResource

Florian Fehring edited this page Oct 5, 2026 · 1 revision

Die UserResource dient der Verwaltung von Benutzern.

Funktion 1: Benutzer anlegen

Vorbedingungen:

  • Ein anlegender Benutzer ist eingeloggt, oder die Selbstregistrierung ist freigeschaltet
  1. Der Benutzer sendet eine POST-Anfrage an (/smartuser/user)
    • Body: JSON-Daten des neuen Benutzers
    • Der Benutzer wird in der Datenbank angelegt
    • Antwort mit Status 201 Created

Ausnahmen:

  1. Der Usermanager konnte nicht initialisiert werden
    • Die Schnittstelle antwortet mit Statuscode 503 (Service unavailable)

Funktion 2: Zählen der Nutzer

Vorbedingungen:

  • keine
  1. Der Benutzer sendet eine GET-Anfrage an (/smartuser/user/count)
    • Antwort mit Status 200 OK und der Anzahl der vorhandenen Benutzer

Ausnahmen:

  1. Der Usermanager konnte nicht initialisiert werden
    • Die Schnittstelle antwortet mit Statuscode 503 (Service unavailable)

Funktion 3: Auflistung aller Benutzer

Vorbedingungen:

  • Der Anfragende Benutzer hat das Recht "user/list"
  1. Liste abfragen

Ausnahmen:

  1. Der Usermanager konnte nicht initialisiert werden
    • Die Schnittstelle antwortet mit Statuscode 503 (Service unavailable)
  2. Der Usermanager signalisiert, dass er nicht bereit ist
    • Die Schnittstelle antwortet mit Statuscode 503 (Service unavailable)
  3. Es tritt ein Fehler beim Abfragen der Benutzerliste auf
    • Die Schnittstelle antwortet mit Statuscode 500 und der Meldung der Exception
  4. Der Benutzer hat nicht das Recht
    • Der Server antwortet mit Statuscode 403
  5. Die Anfrage wird ohne vorherige Anmeldung ausgeführt
    • Der Server antwortet mit Statuscode 401

Funktion 4: Daten eines Benutzers abfragen

Vorbedingungen:

  • Der Anfragende Benutzer hat das Recht "user/get" oder er fragt seine eigenen Daten ab
  1. Liste abfragen

Ausnahmen:

  1. Der Usermanager konnte nicht initialisiert werden
    • Die Schnittstelle antwortet mit Statuscode 503 (Service unavailable)
  2. Der Usermanager signalisiert, dass er nicht bereit ist
    • Die Schnittstelle antwortet mit Statuscode 503 (Service unavailable)
  3. Es tritt ein Fehler beim Abfragen der Benutzerliste auf
    • Die Schnittstelle antwortet mit Statuscode 500 und der Meldung der Exception
  4. Der Benutzer hat nicht das Recht
    • Der Server antwortet mit Statuscode 403
  5. Die Anfrage wird ohne vorherige Anmeldung ausgeführt
    • Der Server antwortet mit Statuscode 401

Funktion 5: Benutzer einloggen

Vorbedingungen:

  • Es wurde mindestens ein Benutzer in der Datenbank angelegt
  1. Der Benutzer sendet seinen Benutzernamen und sein Passwort per POST-Request an(/SmartUser/smartuser/user/performLogin)
    • testPerformLoginRightUser()
    • Es werden die Daten des Benutzers zurückgeliefert (ohne Passwort)
    • Es wird das authtoken cookie gesetzt.

Ausnahmen:

  1. Der Usermanager konnte nicht initialisiert werden
    • Die Schnittstelle antwortet mit Statuscode 503 (Service unavailable)
  2. Der Usermanager signalisiert, das er nicht bereit ist
    • Die Schnittstelle antwortet mit Statuscode 503 (Service unavailable)
  3. Die Zugangsdaten waren falsch, oder der Benutzername ist unbekannt
    • testPerformLoginWrongUser()
    • Die Schnittstelle antwortet mit Statuscode 404

Funktion 6: Benutzer ausloggen

Vorbedingungen:

  • Es wurde mindestens ein Benutzer in der Datenbank angelegt
  • Der Benutzer ist eingeloggt
  1. Der Benutzer sendet die Logout-Anfrage an (/user/perfomLogout)
    • Die Sitzung des Benutzers wird deaktiviert

Ausnahmen:

  1. Der Usermanager konnte nicht initialisiert werden
    • Die Schnittstelle antwortet mit Statuscode 503 (Service unavailable)
  2. Der Benutzer konnte nicht ausgeloggt werden, wegen eines Fehlers im Usermanager
    • Die Schnittstelle liefert eine Warnung mit.

Clone this wiki locally