Get Manageable User List

List all users that can be managed under the current account.

Operation Permissions

  • User login to Application Portal is required.

  • Selecting an OU is required.

Prerequisite

The requester must be the organization administrator.

Request Format

POST https://{apigw-address}/app-portal-service/v2.2/organization/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

UserDTO Struct

The list of the users’ information

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

UserDTO Struct

Name

Data Type

Description

id

String

The user ID

name

String

The user name

domain

String

The domain name

description

String

The description of the user

nickName

String

The nickname of the user

phoneArea

String

The area code of the user’s registered phone number

phone

String

The user’s registered phone number

email

String

The user’s registered email

createdTime

String

The time when this user account was created

joinTime

String

The time when the user joined the current organization

type

Integer

The user type

  • 0: Application Portal account

  • 1: Third-party domain account

exists

Boolean

  • true = the user is in the current organization

  • false = the user is not in the current organization

  • null = the organization is not enabled

updatedTime

String

The update time of the user information

Error Codes

Code

Message

Description

31400

Pagination is required

Pagination is required

31403

Need the primary admin permission

The requester must be the organization administrator to get manageable user list

31512

Organization unselected

Selecting an OU is required

Samples

Request Sample

url: https://{apigw-address}/app-portal-service/v2.2/organization/user/list
method: POST
header:
{
  "Authorization":"yourBearerToken"
}
requestBody: {
    "pageNo":0,
    "pageSize":5,
    "sorters":[]
}

Return Sample


{
    "code": 0,
    "message": "OK",
    "data": {
        "pagination": {
            "totalElements": 5,
            "pageNo": 0,
            "pageSize": 5
        },
        "users": [
            {
                "id": "your_user_id_1",
                "name": "your_user_name_1",
                "domain": "your_user_domain_1",
                "description": "",
                "nickName": "",
                "phoneArea": "",
                "phone": "",
                "email": "your_user_email_1",
                "createdTime": "2019-09-23 02:32:51.0",
                "joinTime": "2019-09-23 02:32:52.0",
                "type": 1
            },
            {
                "id": "your_user_id_2",
                "name": "your_user_name_2",
                "domain": "your_user_domain_2",
                "description": "",
                "nickName": "",
                "phoneArea": "",
                "phone": "",
                "email": "your_user_email_2",
                "createdTime": "2019-09-20 06:46:34.0",
                "joinTime": "2019-09-20 06:46:34.0",
                "type": 1
            },
            {
                "id": "your_user_id_3",
                "name": "your_user_name_3",
                "domain": "your_user_domain_3",
                "description": "",
                "nickName": "",
                "phoneArea": "",
                "phone": "",
                "email": "your_user_email_3",
                "createdTime": "2019-09-19 08:24:17.0",
                "joinTime": "2019-09-19 08:24:17.0",
                "type": 0
            },
            {
                "id": "your_user_id_4",
                "name": "your_user_name_4",
                "domain": "your_user_domain_4",
                "description": "",
                "nickName": "",
                "phoneArea": "",
                "phone": "",
                "email": "your_user_email_4",
                "createdTime": "2019-05-30 07:41:31.0",
                "joinTime": "2019-09-11 09:42:54.0",
                "type": 0
            },
            {
                "id": "your_user_id_5",
                "name": "your_user_name_5",
                "domain": "your_user_domain_5",
                "description": "",
                "nickName": "",
                "phoneArea": "",
                "phone": "",
                "email": "your_user_email_5",
                "createdTime": "2019-05-14 08:38:31.0",
                "joinTime": "2019-09-06 14:09:01.0",
                "type": 0
            }
        ]
    }
}