Konto-Wiederherstellung für einen Benutzer starten

POST /v1/users/{user_id}:start-recovery · Berechtigung user-credentials:write

Sendet einen Wiederherstellungslink (24 Stunden gültig) an die primäre E-Mail-Adresse des Benutzers ohne Wartezeit; dies ist der Weg des Modus admin_only zur Wiederherstellung. Die Anfrage wird direkt als ready geöffnet, und eine offene Wiederherstellungsanfrage wird in derselben Transaktion ersetzt (superseded). Der Link wird nie zurückgegeben. Der optionale Body wählt nur die Sprache der E-Mail aus. Senden Sie einen Idempotency-Key-Header, damit Wiederholungen sicher sind.

Anfrage

Parameter In Erforderlich Beschreibung
user_id Pfad ja Benutzer-ID mit Präfix usr_.

Optionaler Body:

Feld Typ Erforderlich Beschreibung
locale string nein BCP-47-Sprachcode der E-Mail, zum Beispiel tr oder pt-BR. Standardmäßig die Sprache des Benutzers oder der Umgebung.

Antwort

200 OK. request_id identifiziert die Wiederherstellungsanfrage (Präfix arq_); superseded gibt an, ob eine offene Anfrage ersetzt wurde.

{
  "request_id": "arq_0a1b2c3d4e5f6g7h8j9k0m1n2p",
  "expires_at": "2026-01-16T09:30:00Z",
  "superseded": false
}

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.
409 conflict Die Konto-Wiederherstellung ist in den Umgebungseinstellungen auf disabled gesetzt oder der Benutzer hat keine primäre E-Mail-Adresse.
415 unsupported_media_type Ein Body wurde ohne Content-Type: application/json gesendet.
422 validation_failed locale ist kein gültiger BCP-47-Sprachcode oder ein Feld hat den falschen Typ.
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:start-recovery \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"locale": "en"}'