Get Users by User Group¶

Get the user list of a user group.

Operation Permissions¶

You need to assign the permission of “Access user information” to the application in Application Portal.

Request Format¶

POST https://{apigw-address}/app-portal-service/v2.3/userGroup/listAssignedUser

Request Parameters (URI)¶

Name	Mandatory/Optional	Data Type	Description
orgId	Mandatory	String	OU ID

Request Parameters (Body)¶

Name	Mandatory/Optional	Data Type	Description
userGroupId	Mandatory	String	User group ID
pagination	Mandatory	Pagination Struct	Pagination information

Response Parameters¶

Name	Data Type	Description
data	Data Struct	List of user groups

Data Struct¶

Name	Data Type	Description
users	User Struct	List of users
pagination	Pagination Struct	Pagination information

User Struct¶

Name	Data Type	Description
userId	String	User ID
name	String	User name
email	String	User email
phone	String	Phone number
phoneArea	String	The area code of phone number

Pagination Struct¶

Name	Data Type	Description
totalElements	Integer	Total record number
pageNo	Integer	Current page number
pageSize	Integer	Number of entries per page

Error Codes¶

Error Code	Description
31400	Possible causes: missing OU ID, pagination, or user group ID; invalid application; etc.
31404	User, OU, or application does not exist

Samples¶

Request Sample¶

url: https://{apigw-address}/app-portal-service/v2.3/userGroup/listAssignedUser?orgId=your_org_id

method: POST

requestBody:
{
    "userGroupId": "your_user_group_id",
    "pagination": {
        "pageNo": 0,
        "pageSize": 100
    }
}

Return Sample¶

{
    "code": 0,
    "message": "OK",
    "data": {
        "users": [
            {
                "userId": "your_user_id",
                "email": "your_user_email",
                "phone": "",
                "phoneArea": "",
                "name": "your_user_name"
            }
        ],
        "pagination": {
            "totalElements": 3,
            "pageNo": 0,
            "pageSize": 1
        }
    }
}