Get Organization User List¶
不登录Application Portal的状态下授权应用获取指定组织(OU)下所有用户列表。
请求格式¶
POST http://{apigw-address}/app-portal-service/v2.0/user/organization/roster
请求参数(Body)¶
名称 |
是否必须 |
数据类型 |
描述 |
---|---|---|---|
orgId |
true |
String |
资产所属的组织ID。如何获取orgId信息>> |
pagination |
false |
Pagination请求结构体 |
分页参数。见 Pagination请求结构体>>。若不提供,则默认按照每页1000条数据的格式返回第0页的数据。 |
返回参数¶
名称 |
数据类型 |
描述 |
---|---|---|
data |
data结构体 |
以分页列表展示用户信息 |
data结构体¶
名称 |
数据类型 |
描述 |
---|---|---|
pagination |
Pagination结构体 |
分页信息 |
users |
Users结构体 |
用户信息列表 |
Pagination结构体¶
名称 |
数据类型 |
描述 |
---|---|---|
pageNo |
Integer |
请求页数 |
pageSize |
Integer |
每页记录数 |
totalElements |
Long |
总记录数 |
Users结构体¶
名称 |
数据类型 |
描述 |
---|---|---|
userId |
String |
用户的ID |
String |
用户的注册邮箱 |
|
phone |
String |
用户的注册手机号码 |
phoneArea |
String |
用户注册电话的区号 |
name |
String |
用户名 |
示例¶
请求示例¶
POST
http://{apigw-address}/app-portal-service/v2.0/user/organization/roster
requestBody:
{
"orgId": "yourOrgId",
"pagination": {
"pageNo": 0,
"pageSize": 1000,
"sorters": []
}
}
返回示例¶
{
"code": 200,
"message": "",
"data": {
"users": [
{
"userId": userId_1,
"email": "1234",
"phone": "",
"phoneArea": "",
"name": "1234"
},
{
"userId": userId_2,
"email": "71019669@qq.com",
"phone": "",
"phoneArea": "",
"name": "wyf"
}
],
"pagination": {
"totalElements": 2,
"pageNo": 0,
"pageSize": 1000
}
}
}