Forcer une réinitialisation du mot de passe

POST /v1/users/{user_id}:force-password-reset · autorisation user-credentials:write

Oblige l'utilisateur à choisir un nouveau mot de passe : après sa prochaine connexion réussie par mot de passe, il ne peut pas continuer tant qu'il n'a pas défini un nouveau mot de passe. Le hachage de mot de passe actuel n'est pas supprimé : l'utilisateur se connecte une fois de plus avec celui-ci, puis en définit un nouveau. Rappeler l'opération est sans risque : si l'utilisateur est déjà signalé, la date du premier signalement est conservée. L'action est inscrite dans le journal d'audit de gestion (user.password_reset_forced) et émet l'événement password_reset.scheduled. Pour signaler plusieurs utilisateurs à la fois, utilisez Créer une tâche de réinitialisation du mot de passe en masse.

La requête n'a pas de corps (n'en envoyez aucun, ou {}). Envoyez un en-tête Idempotency-Key pour rendre les nouvelles tentatives sûres.

Demande

Paramètre Dans Requis Description
user_id path oui Identifiant de l'utilisateur, préfixé usr_.

Réponse

204 No Content.

Erreurs

Chaque erreur est un corps application/problem+json avec un code stable.

HTTP code Quand
400 malformed_request, unknown_field Le corps n'est pas du JSON valide ou contient un champ inconnu.
401 unauthenticated La clé d'API est absente, invalide ou révoquée.
403 insufficient_permissions La clé ne possède pas l'autorisation user-credentials:write.
404 not_found L'utilisateur n'existe pas dans cet environnement (ou l'identifiant est mal formé).
409 conflict L'utilisateur n'a pas de mot de passe.
429 rate_limited La limite de débit a été dépassée ; respectez Retry-After.
503 service_unavailable Une dépendance est temporairement indisponible ; réessayez plus tard.

Exemple

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