Get App User List


Based on the accessKey of an application, get the list of users who have access to the application.

Operation Permissions


  • User login to Application Portal is required.

  • Sub-administrator permission is required.

Request Format


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

Request Parameters (Header)


Name

Mandatory/Optional

Data Type

Description

Authorization

Mandatory

String

The access token (or bearer token). The format of the parameter’s string is Bearer {your token}. Refer to Log In or Refresh Access Token to learn how to get the access token.

Request Parameters (Body)


Name

Mandatory/Optional

Data Type

Description

pagination

Mandatory

Pagination Request Struct

Lists the paging requirements in a request. If not specified, the default pagination size is 1000 pages, starting from 0. For more details, see Pagination Request Struct

Response Parameters


Name

Data Type

Description

data

Data Struct

The pagination and list of the users’ information.

Data Struct


Name

Data Type

Description

pagination

Pagination Struct

The pagination information.

users

APIUserDTO Struct

The list of the users’ information.

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

Sub-administrator permission is required

31512

Organization is required

Sample

Request Sample


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