Birincil e-postaya parola sıfırlama bağlantısı gönderin

POST /v1/users/{user_id}:send-password-reset · İzin user-credentials:write

Kullanıcının birincil e-posta adresine parola sıfırlama bağlantısı (24 saat geçerli) gönderir. E-posta adresi isteğin bir parçası değildir ve bağlantı hiçbir zaman döndürülmez. İsteğe bağlı gövde yalnızca e-posta dilini seçer. Yeniden denemelerin güvenli olması için bir Idempotency-Key üstbilgisi gönderin.

İstek

Parametre Konum Zorunlu Açıklama
user_id path evet Kullanıcı kimliği, usr_ önekiyle.

İsteğe bağlı gövde:

Alan Tür Zorunlu Açıklama
locale string hayır E-postanın BCP 47 dil etiketi, örneğin tr veya pt-BR. Varsayılan olarak kullanıcının veya ortamın dili kullanılır.

Yanıt

204 No Content. Gövde boştur; bağlantı döndürülmez.

Hatalar

Her hata, kararlı bir code içeren bir application/problem+json gövdesidir.

HTTP code Ne zaman
400 malformed_request, unknown_field Gövde geçerli JSON değil veya bilinmeyen bir alan içeriyor.
409 conflict Kullanıcının birincil e-posta adresi yok veya doğrulanmamış.
415 unsupported_media_type Gövde, Content-Type: application/json olmadan gönderildi.
422 validation_failed locale geçerli bir BCP 47 dil etiketi değil veya bir alanın türü yanlış.
404 not_found Kullanıcı bu ortamda yok (veya kimlik hatalı biçimde).
401 unauthenticated API anahtarı eksik, geçersiz veya iptal edilmiş.
403 insufficient_permissions Anahtarda user-credentials:write izni yok.
429 rate_limited API hız sınırı veya kullanıcı başına e-posta gönderim sınırı aşıldı; Retry-After değerine uyun.
503 service_unavailable Bir bağımlılık geçici olarak kullanılamıyor; daha sonra yeniden deneyin.

Örnek

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"}'