All Products
Search
Document Center

Elastic Desktop Service:ListUserAdOrganizationUnits

Last Updated:Oct 17, 2024

Obtains the organizational units (OUs) of an Active Directory (AD) domain that is connected to an enterprise AD office network (formerly workspace).

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
OfficeSiteIdstringYes

The enterprise AD office network ID.

cn-hangzhou+dir-485361****
FilterstringNo

The string that you enter for fuzzy search.

develop
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request or if no next request exists. You must specify the token that is obtained from the previous query as the value of NextToken.

CAAAAA==
MaxResultsintegerNo

The maximum number of entries to return on each page. Valid values: 1 to 500. Default value: 500.

100

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
OUNamesarray<object>

The OUs of the AD domain.

ouNameobject

The name of the OU in the AD domain.

OfficeSiteIdstring

The enterprise AD office network ID.

cn-hangzhou+dir-485361****
OUNamestring

The canonical name (CNAME) of the OU in the AD domain controller.

example.com/wuying_computers
DisplayOUNamestring

The name of the OU.

wuying_computers
NextTokenstring

A pagination token.

CAAAAA==

Examples

Sample success responses

JSONformat

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "OUNames": [
    {
      "OfficeSiteId": "cn-hangzhou+dir-485361****",
      "OUName": "example.com/wuying_computers",
      "DisplayOUName": "wuying_computers"
    }
  ],
  "NextToken": "CAAAAA=="
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2021-08-23Add OperationView Change Details