Invia un'email di reimpostazione della password

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

Invia il link di reimpostazione della password (valido per 24 ore) all'email principale dell'utente. L'indirizzo non fa parte della richiesta e il link non viene mai restituito. Il corpo opzionale serve solo a selezionare la lingua dell'email. Invia un header Idempotency-Key per rendere sicuri i tentativi ripetuti.

Richiesta

Parametro In Obbligatorio Descrizione
user_id path sì ID utente, con prefisso usr_.

Corpo opzionale:

Campo Tipo Obbligatorio Descrizione
locale string no Tag della lingua BCP 47 dell'email, ad esempio tr o pt-BR. Il valore predefinito è la lingua dell'utente o dell'ambiente.

Risposta

204 No Content. Il corpo è vuoto; il link non viene restituito.

Errori

Ogni errore è un corpo application/problem+json con un code stabile.

HTTP code Quando
400 malformed_request, unknown_field Il corpo non è JSON valido oppure contiene un campo sconosciuto.
409 conflict L'utente non ha un'email principale, oppure non è verificata.
415 unsupported_media_type È stato inviato un corpo senza Content-Type: application/json.
422 validation_failed locale non è un tag della lingua BCP 47 valido, oppure un campo ha un tipo errato.
404 not_found L'utente non esiste in questo ambiente (oppure l'ID è malformato).
401 unauthenticated La chiave API manca, non è valida o è stata revocata.
403 insufficient_permissions La chiave non ha l'autorizzazione user-credentials:write.
429 rate_limited È stato superato il limite di richieste API o il limite di invio email per utente; rispetta Retry-After.
503 service_unavailable Una dipendenza è temporaneamente non disponibile; riprova più tardi.

Esempio

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