Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop Pools/ Querying Users and User Groups Authorized by the Desktop Pool

Updated on 2026-02-10 GMT+08:00

View PDF

Querying Users and User Groups Authorized by the Desktop Pool

Function

Query users and user groups authorized by a specified desktop pool.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:desktopPools:listUsers	List	desktopPool *	-	-	-

URI

GET /v2/{project_id}/desktop-pools/{pool_id}/users

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
pool_id	Yes	String	Specifies the desktop pool ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Where the pagination query starts. The value starts from 0.
limit	No	Integer	Limits the quantity of returned desktops in pagination query. The value ranges from 0 to 100. The default value is 10.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
objects	Array of AuthorizedObjects objects	Authorization object.
total_count	Integer	Total number of users and user groups that meet the conditions.

**Table 4** AuthorizedObjects
Parameter	Type	Description
object_type	String	Enumeration of bound object types. USER: user USER_GROUP: user group
object_id	String	User ID or user group ID.
object_name	String	Username or user group name.
domain	String	Domain name of the user/user group.
user_group	String	Specifies the user permission group to which the desktop user belongs. sudo: Linux administrator group. default: Default Linux user group. administrators: Windows administrator group. Administrators have full access to the desktop and can make any required changes except for forbidden operations. users: Standard Windows user group. Standard users can use most software programs and change system settings that do not affect other users.
created_at	String	Creation time.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 409

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

GET /v2/bcae3e673fd04716a3b9dacdf58ca336/desktop-pools/a130ab3a-72bf-4b71-baa9-af4987c8e338/users

Example Responses

Status code: 200

Response to the request for querying users and user groups authorized by the desktop pool.

{
  "objects" : [ {
    "object_type" : "USER",
    "object_id" : "object_id",
    "object_name" : "2b31e-d520xxxx-xxebedb6-e57xxxxxx",
    "user_group" : "administrators",
    "created_at" : "2022-05-11T11:45:42.000Z"
  } ],
  "total_count" : 1
}

Status Codes

Status Code	Description
200	Response to the request for querying users and user groups authorized by the desktop pool.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
409	Operation conflict.
500	An internal service error occurred. For details about the error code, see the error code description.