1. 接口说明
分页列出当前租户下的用户。
请求方法:GET
请求路径:/api/open/v1/users
2. 认证
需要 HMAC 签名,详见 API 使用说明。
3. 请求参数
3.2 查询参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
page | int | 否 | 页码,默认 1 |
pageSize | int | 否 | 每页条数,默认 20,最大 100 |
keyword | string | 否 | 按 loginName 模糊匹配 |
status | string | 否 | 用户状态:0 正常,1 停用 |
4. 响应参数
4.1 成功响应示例
{
"code": 0,
"data": {
"total": 1,
"list": [{
"userId": 1001,
"loginName": "zhangsan",
"username": "张三",
"email": "",
"phone": "",
"status": "0"
}]
}
}4.2 返回字段(data)
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
total | long | - | 总记录数 |
list | array | - | 用户列表 |
list[].userId | long | - | 用户 ID |
list[].loginName | string | - | 登录名 |
list[].username | string | - | 显示名称 |
list[].email | string | - | 邮箱 |
list[].phone | string | - | 手机号 |
list[].status | string | - | 0 正常 / 1 停用 |