Worum es geht
Manche Registrierungen sollen nicht automatisch durchgehen. Bei der Selbstregistrierung entsteht zum Beispiel ein neuer Mandant, und das soll ein Mensch entscheiden. Dafür gibt es die Freigabe: Der Vorgang wartet nach dem Klick auf den Link, bis ein Plattform-Administrator zustimmt.
Ob ein Ablauf eine Freigabe braucht, steht in seiner Konfiguration: approval-required: true.
Der Ausschnitt
stateDiagram-v2
direction LR
VERIFIED --> PENDING_APPROVAL: Freigabe nötig
PENDING_APPROVAL --> APPROVED: approve
APPROVED --> PROVISIONING
PENDING_APPROVAL --> REJECTED: reject
PROVISIONING --> FAILED: Fehler
FAILED --> PROVISIONING: retry
PENDING_APPROVAL --> EXPIRED: discard
FAILED --> EXPIRED: discard
Die Aktionen
Alle Aktionen liegen unter /cias/admin/registrations/{id}/… und sind POST-Aufrufe.
Wann: Vorgang in PENDING_APPROVAL
approve setzt den Vorgang auf APPROVED und startet im selben Aufruf die Bereitstellung. Eine eigene Mail für die Genehmigung gibt es nicht; die Person bekommt nach der Bereitstellung die Willkommensmail.
Ergebnis: COMPLETED, oder FAILED, wenn die Bereitstellung scheitert.
Wann: Vorgang in einem Zustand, der noch nicht zu Ende ist
reject mit optionalem Grund ({ "reason": "…" }, höchstens 255 Zeichen). Der Vorgang geht nach REJECTED, und die Person bekommt die Mail REJECTED mit dem Grund.
Ergebnis: Endzustand. Die Person kann sich später erneut registrieren.
Wann: Die Bereitstellung ist gescheitert (FAILED).
retry startet die Bereitstellung noch einmal von vorn. Sinnvoll, wenn die Ursache behoben ist, etwa Keycloak wieder erreichbar ist oder eine fehlende Rolle angelegt wurde.
Ergebnis: COMPLETED oder erneut FAILED.
Wann: Vorgang wartet auf den Klick, auf die Freigabe oder ist gescheitert.
discard setzt den Vorgang auf EXPIRED. War es eine Registrierung mit neuem Konto und wurde das Konto nie freigeschaltet, löscht CIAS es in Keycloak. Die Adresse ist danach wieder frei. Eine Mail gibt es nicht.
Ergebnis: Antwort { "identityRemoved": true } oder false.
Wann: Vorgang wartet auf den Klick.
activate bestätigt die Adresse ohne Klick. Siehe E-Mail bestätigen.
Passt der Zustand nicht zur Aktion, etwa approve bei einem Vorgang, der noch auf den Klick wartet, wird die Aktion abgelehnt.
Die Liste der Registrierungen
GET /cias/admin/registrations zeigt alle Vorgänge, ältester zuerst, seitenweise.
| Parameter | Bedeutung |
|---|---|
state | Filter nach Zustand, auch mehrfach, z. B. ?state=PENDING_APPROVAL&state=FAILED |
page | Seite, ab 0 |
size | Einträge je Seite, Standard 50, höchstens 500 |
Jeder Eintrag enthält ID, Adresse, Ablauf, Art, Zustand, Mandantenzuordnung, Mandantenschlüssel, die angegebenen Felder und Zeitstempel. Links und Tokens stehen nie in der Liste.