Get Users Structure List¶

批量获取用户有权访问的组织结构。一次最多可请求 1000 个用户。

前提条件¶

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

请求格式¶

POST https://{apigw-address}/app-portal-service/v2.2/userStructures/structureList

请求参数（Body）¶

名称

必需/可选

数据类型

描述

organizationId

必需

String

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

userIds

必需

List

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

locale

可选

String

指定以何种语言返回列表信息，支持以下赋值：

en_US：英语

zh_CN：中文

es_ES：西班牙语

ja_JP：日语

de_DE：德语

pl_PL：波兰语

默认返回英语 en_US 的列表信息。

响应参数¶

名称	数据类型	描述
usersUserStructures	UsersUserStructureDTO 结构体	用户及其对应组织结构的信息。UsersUserStructureDTO 结构体 >>
userStructures	UserStructureInfoDTO 结构体	组织结构信息。UserStructureInfoDTO 结构体 >>

UsersUserStructureDTO 结构体¶

名称	数据类型	描述
userId	String	用户 ID。
structureIds	List	组织结构 ID 列表。

UserStructureInfoDTO 结构体¶

名称	数据类型	描述
id	String	组织结构 ID。
name	String	组织结构名称。

错误码¶

代码	描述
31400	参数错误，长度错误，不能为空等。
31403	应用未被授予“获取本 OU 内所有用户的权限信息”的权限。
31404	未找到 OU。

示例¶

请求示例¶

url: https://{apigw-address}/app-portal-service/v2.2/userStructures/structureList

method: POST

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

返回示例¶

{
    "code": 0,
    "message": "OK",
    "data": {
        "usersUserStructures": [
            {
                "userId": "your_user_id",
                "structureIds": [
                    "your_node_id_1",
                    "your_node_id_2",
                    "your_node_id_3",
                    "your_node_id_4"
                ]
            }
        ],
        "userStructures": [
            {
                "name": "your_node_name_1",
                "id": "your_node_id_1"
            },
            {
                "name": "your_node_name_2",
                "id": "your_node_id_2"
            },
            {
                "name": "your_node_name_3",
                "id": "your_node_id_3"
            },
            {
                "name": "your_node_name_4",
                "id": "your_node_id_4"
            }
        ]
    }
}