Get App User List¶

根据应用的 accessKey 获得当前用户权限范围内对该应用可见的用户列表信息。

操作权限¶

用户需要登录 EnOS 应用门户。
用户需要拥有子管理员权限。

请求格式¶

POST https://{apigw-address}/app-portal-service/v2.2/user/list

请求参数（Header）¶

名称	位置	必需/可选	数据类型	描述
Authorization	Header	必需	String	Access Token，以Bearer Token表示，其形式为 Bearer {your token}。需要通过调用 Log In 或 Refresh Access Token 接口后获取

请求参数（Body）¶

名称	必需/可选	数据类型	描述
pagination	必需	Pagination 请求结构体	分页参数，参见 Pagination请求结构体>> （若不提供，则默认按照每页1000条数据的格式返回第0页的数据）

响应参数¶

名称	数据类型	描述
data	data 结构体	用户信息列表

data 结构体¶

名称	数据类型	描述
pagination	Pagination结构体	分页信息
users	ApiUserDTO结构体	用户信息

ApiUserDTO结构体¶

名称	数据类型	描述
userId	String	用户ID
email	String	用户的注册邮箱
phoneArea	String	用户注册电话的区号
phone	String	用户注册手机号码
name	String	用户名

错误码¶

代码	描述
31400	分页参数不能为空
31401	提供的 Access Token 无效
31403	需要子管理员权限
31512	未选择 OU

示例¶

请求示例¶

url: https://{apigw-address}/app-portal-service/v2.2/user/list

method: POST

requestBody:
{
  "pagination":{
    "pageSize":1000,
    "pageNo":0
  }
}

返回示例¶

{
  "code": 0,
  "message": "OK",
  "data": {
    "pagination":{
      "totalElements":15000,
      "pageSize":1000,
      "pageNo":0
    },
    "users": [
      {
        "userId": "your_user_id_1",
        "email": "your_user_email_1",
        "phoneArea": "",
        "phone": "",
        "name": "your_user_name_1"
      },
      {
        "userId": "your_user_id_2",
        "email": "your_user_email_2",
        "phoneArea": "",
        "phone": "",
        "name": "your_user_name_2"
      }
    ]
  }
}