Help Center/ Workspace/ API Reference/ Workspace APIs/ User/ Importing the User List

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

View PDF

Importing the User List

Function

Imports the user list.

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:users:importUser	Write	user *	-	-	-

URI

POST /v2/{project_id}/users/desktop-users/action/import

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
vpc_id	No	String	VPC ID.
subnet_id	No	String	Subnet ID.

Request Parameters

**Table 3** FormData parameters
Parameter	Mandatory	Type	Description
file	No	File	The imported user file.

Response Parameters

Status code: 200

**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.
user_detail_list	Array of DesktopUserDetail objects	List of successful tasks.
failed_detail_list	Array of DesktopUserDetail objects	List of failed tasks.
total_count	Integer	Number of users in the list.

**Table 5** DesktopUserDetail
Parameter	Type	Description
id	String	User ID.
user_name	String	Username.
domain	String	Domain to which the user belongs. If this parameter is empty, the primary domain is used by default.
user_email	String	Email address.
permission_group	String	Permission group.
desktop_name	String	Desktop name.
desktop_ip	String	Desktop IP address.
description	String	Description.

Status code: 400

**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: 401

**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: 403

**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: 404

**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.

Status code: 405

**Table 10** 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 11** 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: 503

**Table 12** 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.

Example Requests

{
  "file" : "file"
}

Example Responses

Status code: 200

Response to the request for importing the user list.

{
  "user_detail_list" : [ {
    "id" : "2",
    "user_name" : "lzz",
    "user_email" : "lzz@huawei.com",
    "permission_group" : "default",
    "desktop_name" : "lzz"
  }, {
    "id" : "3",
    "user_name" : "lzz",
    "user_email" : "lzz@huawei.com",
    "permission_group" : "default",
    "desktop_name" : "lzz2"
  } ],
  "failed_detail_list" : [ {
    "id" : "4",
    "user_name" : "lzz",
    "user_email" : "lzz@huawei.com",
    "permission_group" : "default",
    "desktop_name" : "lzz3"
  } ],
  "total_count" : 3
}

Status Codes

Status Code	Description
200	Response to the request for importing the user list.
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.
503	Service unavailable.