4.1.5 获取所有用户
接口说明:
名称 | 内容 |
---|---|
URL | https://xxx/tums/account/v1/queryUserList |
功能说明 | 获取当前系统用户 |
使用限制 | 需要用户管理权限 |
请求参数:
参数名称 | 参数描述 |
---|---|
start long | 搜索开始的位置,范围不小于0 |
limit Integer | 范围1~1000 |
filterAnd Map | 与条件 普通用户条件为("statusLess":1) 获取注册用户为("statusEqual":2) 可通过关键词“nameEqual”、“roleEqual”和“descriptionEqual”
对用户名、角色名和备注进行筛选,也可通过关键词“createTimeLarger”和“createTimeLess”对用户创建的时间范围进行筛选。通过关键词“loginTimeLarger”和“loginTimeLess” “emailNotNull”:null的方式,可以搜索email不为空的用户 |
filterOr Map | 或条件 可通过关键词“roleLike”、“nameLike”、“realNameLike”和 “descriptionLike”,分别对角色名称、用户名称、真实姓名和备注进行模糊搜索。 |
sort List | 排序方式 可通过“lastLoginTime” 、“loginTimes”、“createTime”、“status”或是“expireTime”进行排序 |
返回参数:
参数名称 | 参数描述 | ||
---|---|---|---|
result | userId int | 用户ID | |
username String | 用户名 | ||
realName String | 用户真实姓名 | ||
status int | 用户状态(0:正常, 1:冻结) | ||
String | 电子邮箱 | ||
phone String | 手机号码 | ||
description String | 用户描述信息 | ||
loginTimes int | 登录次数 | ||
onlineStatus int | 在线状态 | ||
loginConstraintVo Object | app int | 允许同时登录的app终端数量 | |
utility int | 允许同时登录的utility终端数量 | ||
web int | 允许同时登录的web终端数量 | ||
loginPlanVo Object | loginPlanId int | 登录模板id | |
userDefinedSign int | 是否用户自定义模板,0:否, 1:是 | ||
planName String | 登录模板名称 | ||
sysDefault boolean | 是否系统内置用户 | ||
allowModifyOwnInfo int | 是否允许更改自身信息,0:否,1:是 | ||
authorityUpdateTime long | 权限更新时间,自1970 年 1 月 1 日至今的秒数 | ||
lastLoginTime long | 最近一次登录时间,自1970 年 1 月 1 日至今的秒数 | ||
expireTime long | 用户到期时间,自1970 年 1 月 1 日至今的秒数 | ||
createTime long | 用户创建时间,自1970 年 1 月 1 日至今的秒数 | ||
previewAllowTime int | 单次预览时长,单位:分钟(-1为不限制) | ||
expired boolean | 用户是否过期 | ||
roleInfo List | roleId int | 角色id | |
roleName String | 角色名称 | ||
error_code | 返回码,0 - 成功,其他 - 失败,具体请参考返回码章节 |
示例
https://xxx/tums/account/v1/queryUserList request: { "start":0, "limit":20, "filterAnd":{}, "filterOr":{}, "sort":[] } response: { "result": { "total": 2, "list": [ { "userId": 1, "username": "admin", "description": "默认超级管理员用户,不可删除", "status": 0, "expireTime": 4102329600, "createTime": 1663743103, "lastLoginTime": 1666924716, "loginTimes": 104, "sysDefault": 1, "expired": false, "roleInfo": [ { "roleId": 1, "roleName": "超级管理员" } ], "onlineStatus": 1, "loginPlanVo": { "loginPlanId": 1, "userDefinedSign": 0, "planName": "全天候模板" }, "previewAllowTime": -1, "loginConstraintVo": { "app": 5, "utility": 5, "web": 1 }, "authorityUpdateTime": "0", "allowModifyOwnInfo": 1 }, { "userId": 2, "username": "testUser", "realName": "test", "description": "123131", "status": 0, "expireTime": 4102415999, "createTime": 1666923188, "loginTimes": 0, "sysDefault": 0, "expired": false, "roleInfo": [ { "roleId": 1, "roleName": "超级管理员" } ], "onlineStatus": 0, "loginPlanVo": { "loginPlanId": 5, "userDefinedSign": 1, "planName": "用户自定义模板二" }, "previewAllowTime": -1, "loginConstraintVo": { "app": 1, "utility": 1, "web": 1 }, "authorityUpdateTime": "1666924711722", "allowModifyOwnInfo": 1 } ] }, "error_code": 0 }