文档首页/ 组织 Organizations/ API参考/ API/ 组织单元管理/ 列出组织单元
更新时间：2024-10-21 GMT+08:00
查看PDF
分享

列出组织单元

功能介绍

列出组织中的所有组织单元。如果指定父级组织单元，则将获得父级直系子级的组织单元列表。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET https://{endpoint}/v1/organizations/organizational-units

表1 Query参数

参数

是否必选

参数类型

描述

parent_id

否

String

父节点（根或组织单元）的唯一标识符（ID）。

limit

否

Integer

页面中最大结果数量。

marker

否

String

分页标记。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

否

String

如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

organizational_units

Array of OrganizationalUnitDto objects

组织单元列表。

page_info

PageInfoDto object

分页信息
表4 OrganizationalUnitDto

参数

参数类型

描述

id

String

与组织单元关联的唯一标识符（ID）。

urn

String

组织单元的统一资源名称。

name

String

组织单元的名称。

created_at

String

组织单元的创建时间。
表5 PageInfoDto

参数

参数类型

描述

next_marker

String

如果存在，则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中，在标签请求参数中使用此值，以获取输出的下一部分。您应该重复此操作，直到next_marker响应元素返回为null。

current_count

Integer

本页返回条目数量

请求示例

列出组织单元

GET https://{endpoint}/v1/organizations/organizational-units

响应示例

状态码： 200

Successful

{
  "organizational_units" : [ {
    "id" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
    "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:ou:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
    "name" : "autoOU0923152729270Pkgk",
    "created_at" : "2022-09-23T07:27:28Z"
  } ],
  "page_info" : {
    "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
    "current_count" : 100
  }
}

状态码

状态码

描述

200

Successful

错误码

请参见错误码。

父主题： 组织单元管理