ListOfficeSiteUsers - WUYING Workspace - Alibaba Cloud Documentation Center

Queries information about Active Directory (AD) users after an enterprise AD office network (formerly workspace) interconnects to an AD domain.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
Filter	string	No	The query string for fuzzy query.	jin
OfficeSiteId	string	Yes	The office network ID. The office network must be of the enterprise AD account type.	cn-hangzhou+dir-363353****
NextToken	string	No	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 query exists. You must specify the token that is obtained from the previous query as the value of NextToken.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
OUPath	string	No	The organizational unit (OU) of the specified AD domain.	example.com/Domain Controllers

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The request ID.	269BDB16-2CD8-4865-84BD-11C40BC21DB0
Users	object []	The usernames of AD users. If the only Administrator and Guest users exist in the enterprise AD, an empty User array is returned.
EndUser	string	The name of the AD user.	Alice
DisplayName	string	The display name of the user.	Alice

Examples

Sample success responses

JSONformat

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "269BDB16-2CD8-4865-84BD-11C40BC21DB0",
  "Users": [
    {
      "EndUser": "Alice",
      "DisplayName": "Alice"
    }
  ]
}

Error codes

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

Change history

Change time

Summary of changes

Operation

2021-08-19

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: OUPath

2021-08-19

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.