Forzar un restablecimiento de contraseña

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

Exige que el usuario elija una contraseña nueva: tras su siguiente inicio de sesión correcto con contraseña, no puede continuar hasta que establezca una contraseña nueva. El hash de contraseña actual no se elimina: el usuario inicia sesión con él una vez más y después establece uno nuevo. Llamarla de nuevo es seguro: si el usuario ya está marcado, se conserva la hora de la primera marca. La acción se escribe en el registro de auditoría de administración (user.password_reset_forced) y emite el evento password_reset.scheduled. Para marcar a muchos usuarios a la vez, use Crear un trabajo masivo de restablecimiento de contraseña.

La solicitud no tiene cuerpo (no envíe ninguno, o envíe {}). Envíe una cabecera Idempotency-Key para que los reintentos sean seguros.

Solicitud

Parámetro En Obligatorio Descripción
user_id ruta sí Id de usuario, con prefijo usr_.

Respuesta

204 No Content.

Errores

Cada error es un cuerpo application/problem+json con un code estable.

HTTP code Cuándo
400 malformed_request, unknown_field El cuerpo no es JSON válido o tiene un campo desconocido.
401 unauthenticated La clave de API falta, no es válida o fue revocada.
403 insufficient_permissions La clave no tiene el permiso user-credentials:write.
404 not_found El usuario no existe en este entorno (o el id tiene un formato incorrecto).
409 conflict El usuario no tiene contraseña.
429 rate_limited Se superó el límite de tasa; respete Retry-After.
503 service_unavailable Una dependencia no está disponible temporalmente; vuelva a intentarlo más tarde.

Ejemplo

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