Enviar un correo para restablecer la contraseña

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

Envía el enlace para restablecer la contraseña (válido durante 24 horas) a la dirección de correo electrónico principal del usuario. La dirección no forma parte de la solicitud y el enlace nunca se devuelve. El cuerpo opcional solo selecciona el idioma del correo. Envíe un encabezado Idempotency-Key para que los reintentos sean seguros.

Solicitud

Parámetro En Obligatorio Descripción
user_id ruta sí ID del usuario, con el prefijo usr_.

Cuerpo opcional:

Campo Tipo Obligatorio Descripción
locale cadena no Etiqueta de idioma BCP 47 del correo, por ejemplo tr o pt-BR. Por defecto se usa el idioma del usuario o del entorno.

Respuesta

204 No Content. El cuerpo está vacío; el enlace no se devuelve.

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.
409 conflict El usuario no tiene correo electrónico principal, o no está verificado.
415 unsupported_media_type Se envió un cuerpo sin Content-Type: application/json.
422 validation_failed locale no es una etiqueta BCP 47 válida, o un campo tiene un tipo incorrecto.
404 not_found El usuario no existe en este entorno (o el ID tiene un formato incorrecto).
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.
429 rate_limited Se superó el límite de frecuencia de la API o el límite de envío de correos por usuario; respete Retry-After.
503 service_unavailable Una dependencia no está disponible temporalmente; reintente más tarde.

Ejemplo

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