Get Structure by User¶

获取用户在某一应用下有权查看的完整组织结构。

前提条件¶

用户已登录应用门户，并进入一个 OU。如有需要，可通过 Log In API 登录应用门户，通过 Choose Organization API 选择 OU。
用户和应用至少需同时关联同一组织结构。如有需要，可联系 OU 管理员分配组织结构。

请求格式¶

GET https://{apigw-address}/app-portal-service/v2.2/structure-service/structures/user

请求参数（URI）¶

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

请求参数（Header）¶

名称

必需/可选

数据类型

描述

locale

可选

String

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

en_US：英语

zh_CN：中文

es_ES：西班牙语

ja_JP：日语

de_DE：德语

pl_PL：波兰语

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

authorization

必需

String

用户登录并选择 OU 后生成的 Access Token，以 Bearer Token 表示，其形式为 Bearer {your token}。可通过调用 Log In 或 Refresh Access Token 接口后获取。

响应参数¶

名称	数据类型	描述
id	String	节点 ID。
parentId	String	父节点 ID。
name	String	组织结构名称。
description	String	组织结构描述。
displayOrder	Integer	排列序号，序号小的排在上方。
children	Data 结构体	子节点。包括 `id`，`parentId`，`name`，`description`，`displayOrder` 和 `children`。

错误码¶

代码	描述
31520	OU 未获取应用。
31530	未启用自动分配组织结构。
31531	组织结构未分配给用户。

示例¶

请求示例¶

url: https://{apigw-address}/app-portal-service/v2.2/structure-service/structures/user?orgId=yourOrgId&appId=yourAppId
method: GET
headers: {"Authorization":"Bearer your_token"}

返回示例¶

{
  "code": 0,
  "message": "OK",
  "data": {
    "id": "your_node_id",
    "parentId": "",
    "name": "your_node_name",
    "description": "",
    "tags": null,
    "displayOrder": 0,
    "assets": null,
    "children": [
      {
        "id": "your_node_id_2",
        "parentId": "your_parent_node_id",
        "name": "your_node_name_2",
        "description": "",
        "tags": {
          "key1": "value1"
        },
        "displayOrder": 0,
        "assets": null,
        "children": [
          {
            "id": "your_node_id_3",
            "parentId": "your_parent_node_id",
            "name": "your_node_name_3",
            "description": "",
            "tags": {},
            "displayOrder": 0,
            "assets": null,
            "children": []
          }
        ]
      }
    ]
  }
}