Get Structure by App¶

获取应用下挂载的组织结构根节点。

请求格式¶

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

请求参数（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 接口后获取。

请求参数（URI）¶

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

响应参数¶

名称	数据类型	描述
id	String	组织结构的根节点 ID。
parentId	String	父节点 ID。当前接口仅返回组织结构的根节点，因此 `parentId` 的值固定为空。
name	String	组织结构名称。
description	String	组织结构描述。
displayOrder	Integer	排列序号，序号小的节点排在上方。
tags	Object	组织结构的标签。

错误码¶

代码	描述
31520	OU 未获取当前应用。

示例¶

请求示例¶

url: https://{apigw-address}/app-portal-service/v2.3/structure-service/structures/app

method: GET

返回示例¶

{
    "code": 0,
    "data": [
        {
            "name": "your_structure_name",
            "displayOrder": 0,
            "description": "",
            "id": "your_structure_id",
            "parentId": "",
            "tags": {
                "key1": "value1"
            }
        }
    ],
    "message": "OK"
}