Get App User List¶

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

请求格式¶

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

请求参数（Header）¶

名称	位置	必需/可选	数据类型	描述
Authorization	Header	必需	String	Access Token，以Bearer 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	用户名。

错误码¶

代码	描述
31401	提供的Access Token无效
31403	需要管理员权限

示例¶

请求示例¶

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": "u15665532373241",
        "email": "1123456666@Fsn.sg",
        "phoneArea": "",
        "phone": "",
        "name": "1123456666@Fsn.sg"
      },
      {
        "userId": "u15665405431611",
        "email": "1qaz@ws.sx",
        "phoneArea": "",
        "phone": "",
        "name": "1qaz"
      }
    ]
  }
}

Java SDK 调用示例¶

public class AppPortalSdkTest{
    @Test
    public void getAppUserList() {
        AppUserListRequest appUserListRequest = new AppUserListRequest("your_access_token");
        AppUserListResponse appUserListResponse = Poseidon.config(PConfig.init().appKey("your_access_key").appSecret("your_secret_key").debug())
                .url("https://{apigw-address}").getResponse(appUserListRequest, AppUserListResponse.class);
        System.out.println("App User List res: " + JSON.toJSONString(appUserListResponse));
        assertNotNull("Response should not be null", appUserListResponse);
        assertNotNull("Response data should not be null", appUserListResponse.data);
        assertNotNull("App users could not be null", appUserListResponse.data.users);
        assertNotNull("user name could not be null", appUserListResponse.data.users.get(0).name);
    }
}