Skip to content

重置用户密码

1. 接口定位

  • 接口名称: 重置用户密码
  • 所属域: admin/user
  • 业务目标: 管理员直接为指定用户设置新密码,并强制踢下线

2. 请求定义

  • Method: POST
  • Path: /user/password/reset
  • Content-Type: 推荐 application/json
  • operationID: 必填,请通过 Header operationID 传入
  • 鉴权: 需要 Header token,且必须是管理员 token
  • 幂等性: 非幂等

3. 请求参数

Header 参数

字段必填类型说明
operationIDstring链路追踪 ID
tokenstring管理员 token

Body 参数

字段必填类型说明
userIDstring要重置密码的目标用户 ID
currentPasswordstring管理员场景下不会参与校验,可不传
newPasswordstring新密码

字段约束

  • userID 不能为空。
  • newPassword 不能为空。
  • 管理员调用 chat ChangePassword 时,currentPassword 不参与校验。

4. 响应结构

通用响应包裹

字段类型说明
errCodeint错误码,0 表示成功
errMsgstring错误简述
errDltstring错误详情
dataobject业务数据

data 字段

  • 成功时返回空对象。

5. 业务规则

  • API 层会调用 chat ChangePassword,但由于上下文用户类型为管理员,所以只要求 userID/newPassword
  • 密码修改成功后,API 层会再获取默认 OpenIM 管理员 token,并调用 ForceOffLine 强制目标用户下线。
  • 如果修改密码成功但强制下线失败,接口会整体返回失败。

6. 错误码与失败场景

错误码场景典型报错
1001userID 为空userID is empty
1001newPassword 为空newPassword is empty
-目标用户不存在由数据库层返回
-更新用户密码失败由 chat 密码更新链路返回
-强制目标用户下线失败由 OpenIM ForceOffLine 链路返回

7. 示例

fetch 请求示例

javascript
fetch("http://localhost:10009/user/password/reset", {
  method: "POST",
  headers: {
    operationID: "550e8400-e29b-41d4-a716-446655440203",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    userID: "9000000001",
    newPassword: "Reset@123",
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例(JSON)

json
{
  "userID": "9000000001",
  "newPassword": "Reset@123"
}

成功响应示例

json
{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {}
}

失败响应示例

json
{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "newPassword is empty"
}

8. 时序流程

  1. 中间件校验管理员 token。
  2. 校验 userID/newPassword
  3. 以管理员身份调用 chat 密码修改逻辑。
  4. 获取默认 OpenIM 管理员 token。
  5. 强制目标用户下线。
  6. 返回统一成功响应。

9. 变更记录

  • 2026-03-31: 首版发布,基于 admin API 密码重置流程、chat 密码修改逻辑和 OpenIM 强制下线逻辑补全文档。