Get App User List¶

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

前提条件¶

用户已登录应用门户，并进入一个 OU。如有需要，可通过 Log In API 登录应用门户，通过 Choose Organization API 选择 OU。
用户需要拥有 OU 管理员或子管理员权限。如有需要，联系系统管理员或 OU 管理员获取权限。

请求格式¶

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

请求参数（Header）¶

名称	必需/可选	数据类型	描述
Authorization	必需	String	用户登录并选择 OU 后生成的 Access Token，以 Bearer Token 表示，其形式为 `Bearer {your token}`。可通过调用 Log In 或 Refresh Access Token 接口后获取。

请求参数（Body）¶

名称	必需/可选	数据类型	描述
pagination	必需	Pagination 请求结构体	分页参数。Pagination 请求结构体 >>

响应参数¶

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

Pagination 结构体 ¶

名称	数据类型	描述
pageNo	Integer	请求页数。
pageSize	Integer	每页记录数。
totalElements	Long	总记录数。

ApiUserDTO 结构体 ¶

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

错误码¶

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

示例¶

请求示例¶

url: https://{apigw-address}/app-portal-service/v2.2/user/list
method: POST
headers: {"Authorization":"Bearer your_token"}
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"
      }
    ]
  }
}