Benutzer entsperren
POST /v1/users/{user_id}:unlock · Berechtigung user-credentials:write
Hebt alle offenen Kontosperren eines Benutzers auf allen Anmeldewegen auf und setzt die Fehlerzähler neu auf null. Für jede aufgehobene Sperre wird das Ereignis user.unlocked (by = admin) geschrieben, und ein Verwaltungs-Audit-Datensatz (user.unlocked) listet die aufgehobenen Sperren auf, mit Ihren Zugangsdaten als Akteur. Ein Benutzer ohne offene Sperre erhält unlocked: 0, und es wird nichts geschrieben; der Aufruf ist deshalb gefahrlos wiederholbar. Um eine einzelne Sperre aufzuheben, verwenden Sie DELETE /v1/attack-protection/lockouts/{lockout_id}.
Anfrage
| Parameter | Ort | Pflicht | Beschreibung |
|---|---|---|---|
user_id |
Pfad | ja | Benutzer-ID mit dem Präfix usr_. |
Die Operation nimmt keinen Body entgegen.
Antwort
200 OK.
{"unlocked": 2}
unlocked ist die Anzahl der aufgehobenen Sperren (höchstens eine pro Anmeldeweg).
Fehler
Jeder Fehler ist ein application/problem+json-Body mit einem stabilen code.
| HTTP | code |
Wann |
|---|---|---|
| 404 | not_found |
Der Benutzer existiert in dieser Umgebung nicht (oder die ID ist fehlerhaft). |
| 401 | unauthenticated |
Der API-Schlüssel fehlt, ist ungültig oder widerrufen. |
| 403 | insufficient_permissions |
Dem Schlüssel fehlt die Berechtigung user-credentials:write. |
| 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_0a1b2c3d4e5f6g7h8j9k0m1n2p:unlock \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY"
CLI: keenauth users unlock usr_0a1b2c3d4e5f6g7h8j9k0m1n2p