获取用户列表

接口说明:获取EIMSNext系统中的用户列表,支持分页、筛选、排序,需携带有效的Token访问。

1. 接口信息

参数 说明
请求方式 GET
接口地址 /api/v1/users
是否需要授权
请求格式 Query String

2. 请求参数

2.1 Header参数

参数名 必选 类型 说明
Authorization string Bearer + Token(例:Bearer eyJhbGciOiJIUzI1Ni...)
Content-Type string application/json

2.2 Query参数

参数名 必选 类型 说明
pageNum int 页码,默认1
pageSize int 每页条数,默认20,最大100
keyword string 搜索关键词(匹配用户名/手机号/邮箱)
status int 用户状态:1-启用,2-禁用,3-锁定
deptId string 部门ID,筛选指定部门的用户
sortBy string 排序字段,支持:createTime、userName、updateTime
sortOrder string 排序方式:asc-升序,desc-降序(默认desc)

3. 请求示例

GET /api/v1/users?pageNum=1&pageSize=20&keyword=张三&status=1&sortBy=createTime&sortOrder=desc HTTP/1.1
Host: eimsnext.example.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: application/json
    

4. 响应结果

200 OK

{
  "code": 200,
  "msg": "查询成功",
  "data": {
    "total": 120,
    "pageNum": 1,
    "pageSize": 20,
    "list": [
      {
        "userId": "10001",
        "userName": "张三",
        "mobile": "13800138000",
        "email": "zhangsan@example.com",
        "deptName": "技术部",
        "status": 1,
        "statusName": "启用",
        "createTime": "2025-01-01 10:00:00",
        "updateTime": "2025-01-10 15:30:00"
      },
      {
        "userId": "10002",
        "userName": "李四",
        "mobile": "13900139000",
        "email": "lisi@example.com",
        "deptName": "财务部",
        "status": 1,
        "statusName": "启用",
        "createTime": "2025-01-02 09:15:00",
        "updateTime": "2025-01-11 11:20:00"
      }
    ]
  }
}
    

4.1 响应参数说明

参数名 类型 说明
code int 响应状态码:200成功,其他失败
msg string 响应提示信息
data object 响应数据体
data.total int 符合条件的总记录数
data.pageNum int 当前页码
data.pageSize int 每页条数
data.list array 用户列表数据
data.list[].userId string 用户ID
data.list[].userName string 用户名
data.list[].mobile string 手机号
data.list[].email string 邮箱
data.list[].deptName string 所属部门名称
data.list[].status int 用户状态:1-启用,2-禁用,3-锁定
data.list[].statusName string 状态名称
data.list[].createTime string 创建时间(YYYY-MM-DD HH:mm:ss)
data.list[].updateTime string 更新时间(YYYY-MM-DD HH:mm:ss)

5. 错误码说明

错误码 说明 解决方案
401 Token无效或过期 重新获取Token并携带有效Token
403 无权限访问 给用户分配用户管理权限
400 参数错误 检查pageSize、status等参数是否合法
500 服务器内部错误 联系技术支持

6. 注意事项