Worum es geht
Die eingeladene Person hat eine Mail mit einem Link bekommen, siehe Einladung durch den Mandanten-Administrator. Der Link enthält ein Token: eine lange Zufallszeichenkette, die nur zu diesem einen Vorgang passt. Mit dem Token kann die Oberfläche zwei Dinge tun:
- anzeigen, welche Angaben die Einladende offen gelassen hat,
- die Einladung annehmen.
Der Ablauf
-
1Benutzer→Frontendöffnet den Link aus der Mail
-
2Frontend→CIAS
GET /cias/registration/invitations/{token}/form -
3CIAS→FrontendListe der Felder des Ablaufs, die noch keinen Wert haben, etwa
firstName -
4Benutzer→Frontendklickt „Einladung annehmen“
-
5Frontend→CIAS
POST /cias/registration/invitations/acceptmit{ "token": "…" } -
6CIASGibt es das Token, und ist es nicht abgelaufen?nein: 404
cias.registration.not-found -
7CIASVorgang →
VERIFIED, dann Freigabe oder Bereitstellung -
8CIAS→KeycloakMitgliedschaft im Mandanten, Mitgliedsrollen. Bei neuer Adresse zusätzlich Konto freischalten
-
9CIAS→E-MailWillkommensmailErgebnis:
202 { "status": "accepted" }, die Person ist Mitglied
Das Annehmen nimmt nur das Token entgegen.
Die Varianten
Wann: Die Oberfläche will zeigen, was noch fehlt.
Die Antwort enthält alle Felder des Ablaufs, zu denen die Einladende keinen Wert angegeben hat, Pflicht- wie freiwillige Felder. Ist das Token unbekannt, antwortet CIAS mit 404.
Wann: Das Token ist gültig, der Vorgang wartet auf den Klick.
Der Vorgang geht nach VERIFIED und läuft weiter wie jede Registrierung: Freigabe, wenn der Ablauf eine verlangt, sonst direkt die Bereitstellung.
Ergebnis: 202, danach Willkommensmail.
Wann: Das Token wurde schon eingelöst, etwa weil das Mailprogramm den Link vorab geöffnet hat oder die Person zweimal klickt.
CIAS tut nichts und antwortet wie beim ersten Mal mit 202. Das ist Absicht: Ein zweiter Klick darf nicht zu einem Fehler führen.
Ergebnis: 202, keine Änderung.
Wann: Das Token gibt es nicht, oder es ist abgelaufen, während der Vorgang noch auf den Klick wartet.
Beide Fälle sehen gleich aus. So kann niemand durch Ausprobieren herausfinden, welche Links es gibt.
Ergebnis: 404 { "error": "cias.registration.not-found", "message": "no open registration for this link" }
Weiter
- E-Mail bestätigen: dieselben Regeln für das Token
- Was beim Abschluss passiert