Get Organization User List¶
Authorize the application to get a list of all users under a specified organization (OU) without logging in the Application Portal.
Request Format¶
POST https://{apigw-address}/app-portal-service/v2.0/user/organization/roster
Request Parameters (Body)¶
Name | Required or Not | Data Type | Description |
---|---|---|---|
orgId | true | String | Organization ID which the asset belongs to. How to get orgId >> |
pagination | false | Pagination request struct | Random pagination. When not specified, the default pagination size is 1000 pages, starting from 0. Pagination Request Struct>> |
Response Parameters¶
Name | Data Type | Description |
---|---|---|
data | data struct | List of user information |
data Struct¶
Name | Data Type | Description |
---|---|---|
pagination | Pagination struct | Pagination information |
users | Users struct | List of user informaton |
Pagination Struct¶
Name | Data Type | Description |
---|---|---|
pageNo | Integer | Request pages |
pageSize | Integer | Number of records in each page |
totalElements | Long | Total number of records |
Users Struct¶
Name | Data Type | Description |
---|---|---|
userId | String | User ID |
String | User’s registered email | |
phone | String | User’s registered phone number |
phoneArea | String | Area code of the user’s registered phone number |
name | String | User name |
Sample¶
Request Sample¶
POST
https://{apigw-address}/app-portal-service/v2.0/user/organization/roster
requestBody:
{
"orgId": "yourOrgId",
"pagination": {
"pageNo": 0,
"pageSize": 1000,
"sorters": []
}
}
Return Sample¶
{
"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
}
}
}