Use ListOfficeSiteUsers to query AD accounts in an enterprise AD office network - Elastic Desktop Service

Queries information about Active Directory (AD) accounts in an AD office network (formerly known as a workspace) that is connected to an AD domain.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. Call DescribeRegions to get a list of regions where WUYING Workspace is available.	cn-hangzhou
Filter	string	No	The query string for fuzzy matching.	jin
OfficeSiteId	string	Yes	The office network ID. Only office networks that use enterprise AD accounts are supported.	cn-hangzhou+dir-363353****
NextToken	string	No	The token for the next page of results. Leave this empty for the first query. For subsequent queries, use the NextToken value from the previous response.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	10
OUPath	string	No	The path of the organizational unit (OU) in the AD domain.	example.com/Domain Controllers
AssignedInfo	string	No
SortType	string	No
IncludeAssignedUser	boolean	No

Response elements

Element	Type	Description	Example
	object	The returned data.
NextToken	string	The token to start the next query. If this parameter is empty, all results have been returned.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The request ID.	269BDB16-2CD8-4865-84BD-11C40BC21DB0
Users	array<object>	An array that consists of the AD accounts. If the enterprise AD contains only the Administrator and Guest users, an empty Users array is returned.
	object	The username of the Active Directory user.
EndUser	string	The username of the AD account.	aduser
DisplayName	string	The display name of the AD account.	aduser
AssignedDesktopNumber	integer
Email	string
Phone	string
UserPrincipalName	string
DisplayNameNew	string

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.