Passwort-Zurücksetzen erzwingen
POST /v1/users/{user_id}:force-password-reset · Berechtigung user-credentials:write
Der Benutzer muss ein neues Passwort wählen: Nach seiner nächsten erfolgreichen Anmeldung mit Passwort kann er erst fortfahren, wenn er ein neues Passwort festgelegt hat. Der aktuelle Passwort-Hash wird nicht gelöscht: Der Benutzer meldet sich ein weiteres Mal mit ihm an und legt danach ein neues Passwort fest. Ein erneuter Aufruf ist unbedenklich: Ist der Benutzer bereits markiert, bleibt der Zeitpunkt der ersten Markierung erhalten. Die Aktion wird im Verwaltungs-Audit-Log (user.password_reset_forced) festgehalten und löst das Ereignis password_reset.scheduled aus. Um viele Benutzer auf einmal zu markieren, verwenden Sie Massen-Passwort-Zurücksetzen als Job anlegen.
Die Anfrage hat keinen Body (senden Sie keinen oder {}). Senden Sie einen Idempotency-Key-Header, damit Wiederholungen sicher sind.
Anfrage
| Parameter | Ort | Pflicht | Beschreibung |
|---|---|---|---|
user_id |
Pfad | ja | Benutzer-ID mit dem Präfix usr_. |
Antwort
204 No Content.
Fehler
Jeder Fehler ist ein application/problem+json-Body mit einem stabilen code.
| HTTP | code |
Wann |
|---|---|---|
| 400 | malformed_request, unknown_field |
Der Body ist kein gültiges JSON oder enthält ein unbekanntes Feld. |
| 401 | unauthenticated |
Der API-Schlüssel fehlt, ist ungültig oder widerrufen. |
| 403 | insufficient_permissions |
Dem Schlüssel fehlt die Berechtigung user-credentials:write. |
| 404 | not_found |
Der Benutzer existiert in dieser Umgebung nicht (oder die ID ist fehlerhaft). |
| 409 | conflict |
Der Benutzer hat kein Passwort. |
| 429 | rate_limited |
Das Ratenlimit wurde überschritten; beachten Sie Retry-After. |
| 503 | service_unavailable |
Eine Abhängigkeit ist vorübergehend nicht verfügbar; versuchen Sie es später erneut. |
Beispiel
curl -X POST https://api.eu.keenauth.com/v1/users/usr_01h455vb4pex5vsknk084sn02q:force-password-reset \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
-H "Idempotency-Key: $(uuidgen)"
CLI: keenauth users force-password-reset usr_01h455vb4pex5vsknk084sn02q