Get Manageable User List¶

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

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 the 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/organization/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	UserDTO Struct	The list of the users’ information. UserDTO 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.

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 address.
createdTime	String	The time when this user account was created.
joinTime	String	The time when the user joined the current OU.
type	Integer	User account type. `0` indicates that the user account is an account registered in Application Portal, `1` indicates that the user account is a third-party domain account.
exists	Boolean	Always return `null`.
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":"Bearer your_token"
}
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,
                "exists": null,
                "updatedTime": "2019-09-23 02:32:52.0"
            },
            {
                "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,
                "exists": null,
                "updatedTime": "2019-09-23 02:32:52.0"
            },
            {
                "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,
                "exists": null,
                "updatedTime": "2019-09-23 02:32:52.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,
                "exists": null,
                "updatedTime": "2019-09-23 02:32:52.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,
                "exists": null,
                "updatedTime": "2019-09-23 02:32:52.0"
            }
        ]
    }
}