Get Manageable User List¶

Get a list of all users that can be managed under the current account.

Request Format¶

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

Request Parameters (Header)¶

Name	Required or Not	Data Type	Description
Authorization	true	String	Access Token, represented as Bearer Token. Refer to Log In or Refresh Access Token to learn how to get Access Token.

Request Parameters (Body)¶

Name	Required or Not	Data Type	Description
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	UserDTO 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

UserDTO Struct¶

Name	Data Type	Description
id	String	User ID
name	String	User name
domain	String	Domain name
description	String	Description of the user
nickName	String	Nickname of the user
phoneArea	String	Area code of the user’s registered phone number
phone	String	User’s registered phone number
email	String	User’s registered email
createdTime	String	Time of creating this user account
joinTime	String	Time of the user joining in the current organization
type	Integer	User type: 0: Application Portal account, 1: third-party domain account
exists	Boolean	Whether the user is in the current organization, if yes, true; if no, false; if the organization is not enabled, null.

Sample¶

Request Sample¶

POST
https://{apigw-address}/app-portal-service/v2.0/organization/user/list
headers: {"Authorization":"Bearer APP_PORTAL_S_TDKKeqfYBK3m5z3LRgKVqThWDYnRBN44"}
body: {
    "pageNo":0,
    "pageSize":5,
    "sorters":[]
}

Return Sample¶

{
    "code": 200,
    "message": "",
    "data": {
        "pagination": {
            "totalElements": 5,
            "pageNo": 0,
            "pageSize": 5
        },
        "users": [
            {
                "id": "userId_1",
                "name": "asd@aaa.com",
                "domain": "新增域测试",
                "description": "",
                "nickName": "",
                "phoneArea": "",
                "phone": "",
                "email": "asd@aaa.com",
                "createdTime": "2019-09-23 02:32:51.0",
                "joinTime": "2019-09-23 02:32:52.0",
                "type": 1
            },
            {
                "id": "userId_2",
                "name": "12345@qq.com",
                "domain": "yangfantest",
                "description": "",
                "nickName": "",
                "phoneArea": "",
                "phone": "",
                "email": "12345@qq.com",
                "createdTime": "2019-09-20 06:46:34.0",
                "joinTime": "2019-09-20 06:46:34.0",
                "type": 1
            },
            {
                "id": "userId_3",
                "name": "435",
                "domain": "",
                "description": "",
                "nickName": "",
                "phoneArea": "",
                "phone": "",
                "email": "435@qq.com",
                "createdTime": "2019-09-19 08:24:17.0",
                "joinTime": "2019-09-19 08:24:17.0",
                "type": 0
            },
            {
                "id": "userId_4",
                "name": "jiajie.chen",
                "domain": "",
                "description": "",
                "nickName": "",
                "phoneArea": "",
                "phone": "",
                "email": "jiajie.chen@envision-digital.com",
                "createdTime": "2019-05-30 07:41:31.0",
                "joinTime": "2019-09-11 09:42:54.0",
                "type": 0
            },
            {
                "id": "userId_5",
                "name": "portal_test01",
                "domain": "",
                "description": "",
                "nickName": "quququ",
                "phoneArea": "",
                "phone": "123232323",
                "email": "portaltest01@email.com",
                "createdTime": "2019-05-14 08:38:31.0",
                "joinTime": "2019-09-06 14:09:01.0",
                "type": 0
            }
        ]
    }
}