Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Changing the Associated Username of a Desktop in the AD Scenario

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

View PDF

Changing the Associated Username of a Desktop in the AD Scenario

Changes the associated username of a desktop in the AD scenario.

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, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:desktops:changeUsername	Write	-	-	-	-

PUT /v2/{project_id}/desktops/change-username

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

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
old_username	Yes	String	If the desktop is associated with the original username, only the username is transferred, without the domain information.
old_user_domain	No	String	Domain of the original user name associated with the desktop.
new_username	Yes	String	If the desktop is associated with a new username, only the username is transferred, without the domain information.
new_user_domain	No	String	Domain of the new user name associated with the desktop.
is_reboot	No	Boolean	Whether to restart the VM after a new username is associated with the desktop. By default, the VM is not restarted.

Status code: 204

Response to the request for changing the username associated with a desktop.

Status code: 400

**Table 3** 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 4** 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 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: 500

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

{
  "old_username" : "user01",
  "new_username" : "user02",
  "is_reboot" : true
}

None

Status Code	Description
204	Response to the request for changing the username associated with a desktop.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
500	Internal server error.