Eine E-Mail zum Zurücksetzen des Passworts senden
POST /v1/users/{user_id}:send-password-reset · Berechtigung user-credentials:write
Sendet den Link zum Zurücksetzen des Passworts (24 Stunden gültig) an die primäre E-Mail-Adresse des Benutzers. Die Adresse ist nicht Teil der Anfrage, und 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
204 No Content. Der Body ist leer; der Link wird nicht zurückgegeben.
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 |
Der Benutzer hat keine primäre E-Mail-Adresse oder sie ist nicht bestätigt. |
| 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 API-Ratenlimit oder das Limit für den E-Mail-Versand pro Benutzer 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:send-password-reset \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"locale": "en"}'