Get Users by User Group¶

获取用户组的用户列表。

前提条件¶

应用需要授予“获取本 OU 内所有用户 ID、账号、邮箱、手机号码”的权限。如有需要，联系 OU 管理员获取权限。

请求格式¶

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

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	OU ID。如何获取 orgId 信息 >>

请求参数（Body）¶

名称	必需/可选	数据类型	描述
userGroupId	必需	String	用户组 ID。可通过 Get Organization User Group List API 获取用户组 ID。
pagination	必需	Pagination 结构体	分页信息。Pagination 请求参数 >>

响应参数¶

名称	数据类型	描述
users	user 结构体	用户列表。user 结构体 >>
pagination	pagination 结构体	分页信息。pagination 结构体 >>

User 结构体 ¶

名称	数据类型	描述
userId	String	用户名 ID。
name	String	用户名。
email	String	用户邮箱。
phone	String	手机号码。
phoneArea	String	手机号码所属区号。

pagination 结构体 ¶

名称	数据类型	描述
totalElements	Integer	总记录数。
pageNo	Integer	当前页码。
pageSize	Integer	当前每页条数。

错误码¶

代码	描述
31400	OU ID 、分页信息或用户组 ID 为空，或应用无效等。
31404	用户、OU 或应用不存在。

示例¶

请求示例¶

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
    }
}

返回示例¶

{
    "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
        }
    }
}