Updated on 2026-01-13 GMT+08:00

Obtaining the OU Tree by Account

Function

This API is used to obtain the OU tree structure to which an account belongs based on the account.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/multi-accounts/organizational-unit-tree

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which is used to identify a specific project.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

entity_id

Yes

String

Entity ID, which is used to identify a specific account.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

ou_list

Array of OrganizationOU objects

Organization unit list.

page_info

PaginationResponse object

Pagination information.

Table 4 OrganizationOU

Parameter

Type

Description

id

String

Organization unit ID.

name

String

Organization unit name.

ou_list

Array of OrganizationOU objects

Sub-organization unit list.

Table 5 PaginationResponse

Parameter

Type

Description

marker

String

Pagination marker.

total

Integer

Total number of records.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded. The OU tree is returned.

401

Unauthorized access to the resource.

403

Access denied. Insufficient permissions.

404

The requested resource does not exist.

Error Codes

See Error Codes.