Kullanıcı için hesap kurtarmayı başlatın
POST /v1/users/{user_id}:start-recovery · İzin user-credentials:write
Bekleme süresi olmadan kullanıcının birincil e-posta adresine bir kurtarma bağlantısı (24 saat geçerli) gönderir; bu, admin_only kurtarma modunun yoludur. İstek doğrudan ready durumunda açılır ve açık bir kurtarma isteği aynı işlemde değiştirilir (superseded). 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
200 OK. request_id kurtarma isteğini tanımlar (önek arq_); superseded, açık bir isteğin değiştirilip değiştirilmediğini belirtir.
{
"request_id": "arq_0a1b2c3d4e5f6g7h8j9k0m1n2p",
"expires_at": "2026-01-16T09:30:00Z",
"superseded": false
}
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 |
Ortam ayarlarında hesap kurtarma disabled durumda veya kullanıcının birincil e-posta adresi yok. |
| 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 |
Hız 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:start-recovery \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"locale": "en"}'