ListOfficeSiteUsers - Elastic Desktop Service - Alibaba Cloud Documentation Center

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

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ecd:ListOfficeSiteUsers	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.	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	array<object>	The usernames of the AD accounts. If the only Administrator and Guest users exist in the enterprise AD directory, an empty User array is returned.
User	object	The username of the AD account.
EndUser	string	The username of the AD account.	Alice
DisplayName	string	The display name of the AD account.	Alice

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-04-09	The response structure of the API has changed	View Change Details
2021-08-19	The request parameters of the API has changed	View Change Details
2021-08-19	The response structure of the API has changed	View Change Details