Get Users Structure List


不登录 EnOS 应用门户的状态下获取一批用户的组织结构。

操作权限


需要在 EnOS 应用门户给应用授权“获取本 OU 内所有用户的权限信息”的权限。

请求格式


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

请求参数(Body)


名称 必需/可选 数据类型 描述
organizationId 必需 String 组织 ID。如何获取 organizationId 信息>>
userIds 必需 List 用户 ID 列表
locale 可选 String

语言代码。不填默认为 default 值

  • 英语为 en_US
  • 中文为 zh_CN
  • 西班牙语为 es_ES
  • 日语为 ja_JP

响应参数


名称 数据类型 描述
data data 结构体 用户及其对应组织结构的信息

data 结构体


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

UsersUserStructureDTO 结构体


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

UserStructureInfoDTO 结构体


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

错误码


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

示例

请求示例


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