Forzare una reimpostazione della password
POST /v1/users/{user_id}:force-password-reset · permesso user-credentials:write
Richiede all'utente di scegliere una nuova password: dopo il suo prossimo accesso riuscito con password non può proseguire finché non imposta una nuova password. L'hash della password attuale non viene eliminato: l'utente accede ancora una volta con esso e poi ne imposta uno nuovo. Richiamare l'operazione più volte è sicuro: se l'utente è già contrassegnato, viene mantenuta l'ora del primo contrassegno. L'azione viene scritta nel log di audit di gestione (user.password_reset_forced) e genera l'evento password_reset.scheduled. Per contrassegnare più utenti contemporaneamente, usare Creare un job di reimpostazione della password in blocco.
La richiesta non ha un corpo (non inviarne uno, oppure {}). Inviare un'intestazione Idempotency-Key per rendere sicuri i nuovi tentativi.
Richiesta
| Parametro | In | Obbligatorio | Descrizione |
|---|---|---|---|
user_id |
percorso | sì | ID utente, con prefisso usr_. |
Risposta
204 No Content.
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 ha un campo sconosciuto. |
| 401 | unauthenticated |
La chiave API è mancante, non valida o revocata. |
| 403 | insufficient_permissions |
La chiave non ha il permesso user-credentials:write. |
| 404 | not_found |
L'utente non esiste in questo ambiente (oppure l'ID non è valido). |
| 409 | conflict |
L'utente non ha una password. |
| 429 | rate_limited |
È stato superato il limite di frequenza; rispettare Retry-After. |
| 503 | service_unavailable |
Una dipendenza non è temporaneamente disponibile; riprovare più tardi. |
Esempio
curl -X POST https://api.eu.keenauth.com/v1/users/usr_01h455vb4pex5vsknk084sn02q:force-password-reset \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
-H "Idempotency-Key: $(uuidgen)"
CLI: keenauth users force-password-reset usr_01h455vb4pex5vsknk084sn02q