Get Users Role List


批量获取用户的角色。一次最多可获取 1000 个用户的角色。

前提条件


应用需拥有“获取本 OU 内所有用户的权限信息”的权限。如有需要,联系 OU 管理员获取权限。

请求格式


POST https://{apigw-address}/app-portal-service/v2.2/userRoles/roleList

请求参数(Body)


名称

必需/可选

数据类型

描述

organizationId

必需

String

OU ID。如何获取 organizationId 信息 >>

userIds

必需

List

用户 ID 列表,支持输入最多 1000 个用户 ID。如何获取 userId 信息 >>

响应参数


名称

数据类型

描述

usersUserRoles

UsersUserRolesDTO 结构体

用户及其对应角色的信息。UsersUserRolesDTO 结构体 >>

userRoles

UsersRolesInfoDTO 结构体

角色信息。UsersRolesInfoDTO 结构体 >>

UsersUserRolesDTO 结构体


名称

数据类型

描述

userId

String

用户 ID。

roleIds

List

角色 ID 列表。

UsersRolesInfoDTO 结构体


名称

数据类型

描述

id

String

角色 ID。

name

String

角色名称。

错误码


代码

描述

31400

参数错误,长度错误,不能为空等

31403

应用未被授予“获取本 OU 内所有用户的权限信息”的权限

31404

未找到 OU

示例

请求示例


url: https://{apigw-address}/app-portal-service/v2.2/userRoles/roleList

method: POST

requestBody:
{"organizationId":"yourOrgId","userIds": ["user1","user2","user3"]}

返回示例


{
    "code": 0,
    "message": "OK",
    "data": {
        "usersUserRoles": [
            {
                "userId": "your_user_id_1",
                "roleIds": [
                    "your_role_id_1",
                    "your_role_id_2",
                    "your_role_id_3",
                    "your_role_id_4",
                    "your_role_id_5"
                ]
            },
            {
                "userId": "your_user_id_2",
                "roleIds": []
            }
        ],
        "userRoles": [
            {
                "id": "your_role_id_1",
                "name": "your_role_name_1"
            },
            {
                "id": "your_role_id_2",
                "name": "your_role_name_2"
            },
            {
                "id": "your_role_id_3",
                "name": "your_role_name_3"
            },
            {
                "id": "your_role_id_4",
                "name": "your_role_name_4"
            },
            {
                "id": "your_role_id_5",
                "name": "your_role_name_5"
            }
        ]
    }
}