更新用户资料
查看文档来源信息
- 来源目录:
addons/sys_base/docs - 来源文件:
接口文档/59-更新用户资料.md
详细说明
用于更新中间件全局用户基础资料、账号状态和所属部门;当用户编号不符合当前部门编码规则时,会在本次保存中重新生成。
接口信息
| 项目 | 内容 |
|---|---|
| 请求方式 | PUT |
| 请求路径 | /sys_base/platform/user/setUserInfo |
| 来源文件 | 接口文档/59-更新用户资料.md |
请求头
| 请求头 | 示例值 | 说明 |
|---|---|---|
Content-Type | application/json | 请求体格式。 |
x-token | <登录令牌> | 登录令牌。 |
app-id | mid-admin | 当前应用 ID。 |
addons-type | sys_base | 当前模块标识。 |
入参
| 参数名 | 类型 | 是否必填 | 示例值 | 参数说明 |
|---|---|---|---|---|
ID | number | 是 | 1001 | 用户 ID |
nickName | string | 是 | 张三 | 用户昵称 |
phone | string | 是 | 13800000000 | 手机号,需唯一 |
email | string | 否 | zhangsan@example.com | 邮箱 |
headerImg | string | 否 | https://example.com/avatar.png | 头像地址 |
sideMode | string | 否 | dark | 侧边主题 |
enable | number | 是 | 1 | 账号状态,1 正常、2 停用 |
isSuperAdmin | boolean | 否 | false | 是否为系统超级管理员,仅超级管理员可修改 |
organizationID | number | 是 | 2001 | 用户所属部门 ID |
参数说明
organizationID是用户全局部门归属,不按模块拆分。publicId不允许由前端直接写入;后端会读取目标部门orgFlag,在用户编号为空、格式不合法或前缀不匹配时重新生成。- 如果目标部门编码不符合 1 到 8 位大写英文字母或数字、必须以字母开头的规则,更新会失败,需要先修正部门编码。
- 本接口不直接处理全量角色替换;角色列表由“设置用户角色列表”接口维护。
请求示例
json
{
"ID": 1001,
"nickName": "张三",
"phone": "13800000000",
"email": "zhangsan@example.com",
"headerImg": "https://example.com/avatar.png",
"sideMode": "dark",
"enable": 1,
"isSuperAdmin": false,
"organizationID": 2001
}响应输出
json
{
"code": 1000,
"msg": "操作成功",
"data": {
"success": true,
"id": 1
}
}字段说明
| 字段名 | 类型 | 示例值 | 字段说明 |
|---|---|---|---|
code | number | 1000 | 业务状态码 |
msg | string | 操作成功 | 返回消息 |
data.success | boolean | true | 操作结果 |
data.id | number | 1 | 受影响记录 ID |
curl 示例
bash
curl --location --request PUT 'http://127.0.0.1:8100/sys_base/platform/user/setUserInfo' \
--header 'Content-Type: application/json' \
--header 'x-token: <登录令牌>' \
--header 'app-id: mid-admin' \
--header 'addons-type: sys_base' \
--data-raw '{
"ID": 1001,
"nickName": "张三",
"phone": "13800000000",
"email": "zhangsan@example.com",
"headerImg": "https://example.com/avatar.png",
"sideMode": "dark",
"enable": 1,
"isSuperAdmin": false,
"organizationID": 2001
}'