开发者平台

TP-LINK官网首页
开发者平台 / 视频管理系统(VMS)/ API功能接口定义 / 用户管理

4.1.4 获取所有用户

接口说明:

名称

内容

URL

https://xxx/tums/account/v1/queryUserList

功能说明

获取当前系统用户

使用限制

需要用户管理权限

请求参数:

参数名称

参数描述

params

grid

start

long

搜索开始的位置

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:冻结)

email

String

电子邮箱

phone

String

手机号码

description

String

用户描述信息

loginTimes

int

登录次数

sysDefault

boolean

是否系统内置用户

lastLoginTime

long

最近一次登录时间,自1970 年 1 月 1 日至今的秒数

expireTime

long

用户到期时间,自1970 年 1 月 1 日至今的秒数

createTime

long

用户创建时间,自1970 年 1 月 1 日至今的秒数

expired

boolean

用户是否过期

roleInfo

List

角色信息(包含角色ID和角色名称)

error_code

返回码,0 - 成功,其他 - 失败,具体请参考返回码章节

示例

            https://xxx/tums/account/v1/queryUserList
            request:
            {
	            "start":0,
	            "limit":20,
	            "filterAnd":{},
	            "filterOr":{},
	            "sort":[]
            }
            response:
            {
                "result": [
                    {
                        "username": "admin",
                        "realName": "超级管理员",
                        "email": "123@qq.com",
                        "phone": "123123123",
                        "description": "超级管理员拥有所有权限,不可删除",
                        "status": 0,
                        "expireTime": 0,
                        "lastLoginTime": 0,
                        "loginTimes": 0,
                        "sysDefault": true,
                        "expired": true,
                        "roleInfo": [
                            {
                                "roleId": 1,
                                "roleName": "超级管理员"
                            }
                        ]
                    },
                    {
                        "username": "lan",
                        "realName": "weitao",
                        "email": "testest@qq.com",
                        "phone": "13987654321",
                        "description": "test user",
                        "status": 0,
                        "expireTime": 0,
                        "sysDefault": false,
                        "expired": true,
                        "roleInfo": [
                            {
                                "roleId": 8,
                                "roleName": "testRole2"
                            },
                            {
                                "roleId": 9,
                                "roleName": "testRole3"
                            }
                        ]
                    }
                ],
                "error_code": 0
            }