Get App User List¶

Get the list of users visible to the application within the administrator’s permission according to the application’s accessKey.

Prerequisites¶

The user has logged in to Application Portal and entered an OU. You can log in to Application Portal through the Log In API and select the OU through the Choose Organization API.
The user has OU administrator or sub-administrator permission. Contact the system administrator or OU administrator to get the permission if necessary.

Request Format¶

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

Request Parameters (Header)¶

Name	Required/Optional	Data Type	Description
Authorization	Required	String	The access token generated after the user logs in and selects the OU, represented by Bearer Token, is in the form of `Bearer {your token}`. You can call the Log In or Refresh Access Token API to obtain the access token.

Request Parameters (Body)¶

Name	Required/Optional	Data Type	Description
pagination	Required	Pagination Request Struct	Lists the paging requirements in a request. Pagination Request Struct >>

Response Parameters¶

Name	Data Type	Description
pagination	Pagination Struct	The pagination information. Pagination Struct >>
users	APIUserDTO Struct	The list of the users’ information. ApiUserDTO Struct >>

Pagination Struct¶

Name	Data Type	Description
pageNo	Integer	The request pages.
pageSize	Integer	The number of records in each page.
totalElements	Long	The total number of records.

APIUserDTO Struct¶

Name	Data Type	Description
userId	String	User ID.
email	String	The user’s registered email address.
phoneArea	String	The area code of the user’s registered phone number.
phone	String	The user’s registered phone number.
name	String	User name.
updatedTime	String	The update time of the user information.

Error Code¶

Code	Description
31400	Pagination is required
31401	The access token is invalid
31403	OU administrator or sub-administrator permission is required
31512	Selecting an OU is required

Sample¶

Request Sample¶

url: https://{apigw-address}/app-portal-service/v2.2/user/list
method: POST
headers: {"Authorization":"Bearer your_token"}
requestBody:
{
  "pagination":{
    "pageSize":1000,
    "pageNo":0
  }
}

Return Sample¶

{
  "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"
      }
    ]
  }
}