Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Updating a Desktop SID

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

View PDF

Updating a Desktop SID

Function

If the desktop SID is different from the SID of the Windows AD, update the desktop SID to make both SIDs the same. This API is used when the desktop is not in the domain.

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

URI

PUT /v2/{project_id}/desktops/sids

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

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
desktop_ids	Yes	Array of strings	VM list.

Response Parameters

Status code: 200

Desktop SID updated.

Status code: 202

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

Status code: 204

Desktop SID not changed.

Status code: 400

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

Example Requests

/v2/{project_id}/desktops/sids

{
  "desktop_ids" : [ "48f3531f-6cde-49c7-8756-7f697a41241a", "234f-6cde-4fcxxx7-8756-723acca1241ac" ]
}

Example Responses

Status code: 202

A task for updating SIDs in batches has been created.

{
  "job_id" : "string"
}

Status Codes

Status Code	Description
200	Desktop SID updated.
202	A task for updating SIDs in batches has been created.
204	Desktop SID not changed.
400	Desktop ID not found.
412	Desktop SID cannot be updated.
default	Default error response.