新增用户
查看文档来源信息
- 来源目录:
addons/sys_base/docs - 来源文件:
接口文档/51-新增用户.md
详细说明
用于新增中间件全局用户,写入所属部门关系,并按部门编码生成用户编号。
接口信息
| 项目 | 内容 |
|---|---|
| 请求方式 | POST |
| 请求路径 | /sys_base/platform/user/admin_register |
| 来源文件 | 接口文档/51-新增用户.md |
请求头
| 请求头 | 示例值 | 说明 |
|---|---|---|
Content-Type | application/json | 请求体格式。 |
x-token | <登录令牌> | 登录令牌。 |
app-id | mid-admin | 当前应用 ID。 |
addons-type | sys_base | 当前模块标识。 |
入参
| 参数名 | 类型 | 是否必填 | 示例值 | 参数说明 |
|---|---|---|---|---|
userName | string | 是 | zhangsan | 用户名 |
nickName | string | 是 | 张三 | 姓名 |
password | string | 是 | Aa123456! | 初始密码,必须满足密码复杂度规则 |
phone | string | 是 | 13800000000 | 手机号,需唯一 |
email | string | 否 | zhangsan@example.com | 邮箱 |
organizationID | number | 是 | 2001 | 所属部门 ID |
authorityId | number | 是 | 888 | 主角色 ID,通常取 authorityIds 的第一个角色 |
authorityIds | array | 是 | [888] | 角色 ID 列表 |
enable | number | 否 | 1 | 账号状态,1 正常、2 停用 |
isSuperAdmin | boolean | 否 | false | 是否授予系统超级管理员身份,仅超级管理员可设置 |
参数说明
userName:用户名。nickName:姓名。password:初始密码。organizationID:部门 ID,新增成功后用户与该部门建立全局归属关系。authorityId:主角色 ID。authorityIds:角色 ID 列表。- 用户编号
publicId不由前端传入,由后端按目标部门orgFlag + 4 位数字自动生成,例如JS0001。 - 如果目标部门编码不符合 1 到 8 位大写英文字母或数字、必须以字母开头的规则,新增用户会失败。
请求示例
json
{
"userName": "zhangsan",
"nickName": "张三",
"password": "Aa123456!",
"phone": "13800000000",
"email": "zhangsan@example.com",
"organizationID": 2001,
"authorityId": 888,
"authorityIds": [
888
],
"enable": 1,
"isSuperAdmin": false
}响应输出
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 POST 'http://127.0.0.1:8100/sys_base/platform/user/admin_register' \
--header 'Content-Type: application/json' \
--header 'x-token: <登录令牌>' \
--header 'app-id: mid-admin' \
--header 'addons-type: sys_base' \
--data-raw '{
"userName": "zhangsan",
"nickName": "张三",
"password": "Aa123456!",
"phone": "13800000000",
"email": "zhangsan@example.com",
"organizationID": 2001,
"authorityId": 888,
"authorityIds": [
888
],
"enable": 1,
"isSuperAdmin": false
}'