Help Center/ Workspace/ API Reference/ Workspace APIs/ OU/ Querying OUs in the AD Domain

Updated on 2025-07-14 GMT+08:00

View PDF

Querying OUs in the AD Domain

Queries OUs in the AD domain.

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

GET /v2/{project_id}/ad-ous

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Limits the quantity of returned desktops in pagination query. If this parameter is not specified, all desktops that meet the search criteria are returned.
offset	No	Integer	Where the pagination query starts. The value starts from 0.

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	Yes	String	MIME type of the request body, for example, application/json.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
ou_infos	Array of AdOuInfo objects	OU object.
total_count	Integer	Total number of OU records.

**Table 5** AdOuInfo
Parameter	Type	Description
ou_name	String	Name.
ou_dn	String	Domain name address.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 405

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 503

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

None

Status code: 200

Queries OU information.

{
  "ou_infos" : [ {
    "ou_name" : "wksmanager",
    "ou_dn" : "OU=UserOU,DC=vdesktop,DC=huawei,DC=com"
  } ],
  "total_count" : 1
}

Status Code	Description
200	Queries OU information.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
405	The method specified in the request is not allowed.
500	An internal service error occurred. For details, see the error code description.
503	Service unavailable.