Queries the details about Active Directory (AD) users in an AD workspace after the workspace is connected to an AD domain.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListOfficeSiteUsers

The operation that you want to perform. Set the value to ListOfficeSiteUsers.

OfficeSiteId String Yes cn-hangzhou+dir-363353****

The ID of the workspace. Only workspaces of the enterprise AD account type are supported.

RegionId String Yes cn-hangzhou

The ID of the region.

Filter String No *jin*

The character string for fuzzy search.

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The token that specifies the start point of the next query.

MaxResults Integer No 10

The number of entries to return on each page.

Maximum value: 100

Default value: 10

OUPath String No example.com/Domain Controllers

The organizational unit (OU) in the specified AD domain.

Response parameters

Parameter Type Example Description
NextToken String caeba0bbb2be03f84eb48b699f0a4883

The token used for the next query. If no additional results exist, all results are returned.

RequestId String 269BDB16-2CD8-4865-84BD-11C40BC21DB0

The ID of the request.

Users Array of User

The usernames of AD users.

This parameter is empty if the AD users include only Administrator and Guest.

EndUser String Alice

The username of the AD user.


Sample requests

&<Common request parameters>

Sample success responses

XML format


JSON format

    "RequestId": "269BDB16-2CD8-4865-84BD-11C40BC21DB0",
    "Users": [{
        "EndUser": "Alice"