POST/api/auth/forgot-password

启动密码重置:如果存在使用该电子邮件地址的账户,该账户将收到一封包含重置链接的电子邮件。

在 `email` 字段中发送账户的电子邮件地址。响应 `{"ok":true}` 刻意始终保持一致——无论账户是否存在——这样就无法通过该端点判断哪些地址已注册。随后使用邮件中的令牌,通过 `POST /api/auth/reset-password` 设置新密码。 如果 `email` 字段缺失或为空,端点会以 400 `VALIDATION_ERROR` 响应。为防止滥用,每个 IP 地址的请求数量受到限制(429 `RATE_LIMIT_EXCEEDED`)。

概览

调用:POST /api/auth/forgot-password。该端点属于 Zentor App API 的“身份验证”分组。 该端点可公开访问,无需身份验证。 该调用是幂等的:使用相同输入重复调用将返回相同结果。 必填参数:email (请求体)。 已记录的错误情况:400 VALIDATION_ERROR。 下方的示例响应展示了 JSON 格式的成功响应结构。

身份验证与安全

无需身份验证

幂等: 是

参数

email(body, string,必填)— 账户的电子邮件地址

请求示例

{"email":"user@example.com"}

响应示例

{"ok":true}

错误代码

400 VALIDATION_ERROR — `email` 字段缺失或为空。

已验证的行为

无论账户是否存在,响应均为 200 `{"ok":true}`;缺少电子邮件字段返回 400 `VALIDATION_ERROR`。

身份验证

相关文章

← 身份验证