Help Center/ Workspace/ API Reference/ Workspace APIs/ User Group/ Exporting Users in a User Group

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

View PDF

Exporting Users in a User Group

Exports users in a user group in an Excel file.

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

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, no identity policy-based permission required for calling this API.

GET /v3/{project_id}/groups/{group_id}/users/export

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
group_id	Yes	String	Desktop user group ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
user_name	No	String	The username supports fuzzy search.
description	No	String	The user description supports fuzzy search.
active_type	No	String	Activation type. USER_ACTIVATE: The subscriber is activated. ADMIN_ACTIVATE: activated by the administrator
group_name	No	String	User group name.
language	No	String	Language. zh_CN: Chinese en_US: English
enterprise_project_id	No	String	Enterprise project ID.

None

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
task_id	String	ID of the export task.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
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 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
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 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
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 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
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: 405

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
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 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

GET /v3/29dfe82ada564ac2b927e1ff036d9a9b/users/export

None

Status Code	Description
200	Task ID
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
405	The method specified in the request is not allowed.
500	An internal service error occurred. For details about the error code, see the error code description.