Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Rejoining a Desktop to the AD Domain

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

View PDF

Rejoining a Desktop to the AD Domain

Rejoins a Windows desktop to the AD domain. This API is used when the desktop is not in the domain.

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:rejoinDomain	Write	desktop *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-	-

POST /v2/{project_id}/desktops/{desktop_id}/rejoin-domain

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

None

Status code: 202

**Table 2** Response body parameters
Parameter	Type	Description
job_id	String	Task ID.

Status code: 404

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

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

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

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

None

Status code: 202

A task for rejoining the domain has been created.

{
  "job_id" : "string"
}

Status Code	Description
202	A task for rejoining the domain has been created.
404	Desktop not found.
409	Operation conflict.
412	The desktop cannot rejoin the domain.
default	Default error response.