Recuperar contraseña de usuario
API operation: Open the endpoint in Scalar
Usa POST /users/forgot para solicitar un correo electrónico de restablecimiento de contraseña. La operación pública actual es User.forgot y no requiere un usuario autenticado.
{
"email": "user@example.com"
}
Cuando la operación acepta una solicitud válida, pone en cola un correo de restablecimiento. La configuración del proyecto y el contexto de la solicitud determinan la URL de destino; los límites de solicitudes pueden restringir los intentos repetidos.
Una respuesta exitosa de la API confirma que la solicitud fue aceptada para su procesamiento; no confirma que se haya entregado el correo ni que se haya completado el restablecimiento de la contraseña.
Ejemplo de SDK heredado
const response = await ordering.users().forgotPassword({email: email})
Confirma el paquete y la versión del SDK antes de usar este helper.
Referencia de OpenAPI
Operación: POST /users/forgot
Parámetros de encabezado
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
X-APP-X | string | No | — |
Origin | string | No | — |
Referer | string | No | — |
X-INTERNAL-PRODUCT-X | string | No | — |
Campos del cuerpo de la solicitud
| Nombre | Tipo | Obligatorio |
|---|---|---|
email | any | No |
Respuestas
| Código | Descripción |
|---|---|
| 200 | Respuesta exitosa. El contenido de result varía según la operación y se devuelve como JSON. |
| 400 | Respuesta de error (error=true). Los errores de validación y de negocio comparten este código. |
| 401 | Envelope de error: el proyecto no existe o no tiene una suscripción activa. |
| 404 | Respuesta vacía: la versión de API solicitada no está admitida. |
| 429 | Envelope de error: se excedió un límite de consumo del proyecto (o el sujeto está baneado). Lleva Retry-After y X-RateLimit-Limit/Remaining/Reset/Scope/Key. |
| 500 | Respuesta de error: falló la búsqueda o inicialización del proyecto. |
| 503 | Envelope de error: la aplicación está temporalmente en mantenimiento. Envelope de error: el proyecto está temporalmente en mantenimiento, o los límites de consumo no se pudieron evaluar y el límite aplicable está configurado con on_error = closed (cabecera Retry-After: 1). |