Appearance
本文档非官方出品,主要由 AI 辅助编写,不保证绝对准确。如有疑问,请以 kernel/api/ 中的源码为准。
如果您觉得本文档有帮助,可以考虑赞助支持:爱发电
反激活用户账号
端点
/api/account/deactivate
接口描述
此 API 端点用于反激活(注销)当前登录的用户账号。它会向思源笔记的云服务器发送请求来执行反激活操作。
认证与授权
此接口需要满足以下所有条件才能访问:
- 用户认证 (
model.CheckAuth
): 需要有效的用户认证,并通过Authorization
HTTP 头部传递 API Token - 管理员权限 (
model.CheckAdminRole
): 调用者必须具有管理员角色权限 - 非只读模式 (
model.CheckReadonly
): 系统不能处于只读模式
请求方法
POST
请求参数
此接口不需要请求参数。
返回值
参数名 | 类型 | 描述 |
---|---|---|
code | number | 返回码。0: 成功; -1: 失败 |
msg | string | 返回信息。失败时包含错误信息 |
可能的错误情况:
- 未登录或 token 无效 (HTTP 401)
- 连接云服务器失败
- 云服务器返回错误
示例
请求示例
json
POST /api/account/deactivate
Content-Type: application/json
Authorization: Token your-token
{}
返回示例 (成功)
json
{
"code": 0,
"msg": ""
}
返回示例 (未登录)
json
{
"code": -1,
"msg": "未登录"
}
返回示例 (服务器错误)
json
{
"code": -1,
"msg": "无法连接到云端服务器"
}
备注
- 此操作会注销用户账号,请谨慎使用
- 操作成功后会清除本地的用户信息
- 需要确保网络连接正常且用户已登录(需要用户 token)
- 建议在执行此操作前向用户显示确认对话框