Unbinding a User

Unbinds a desktop from a user.

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:detach	Write	desktop *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-	vpc:ports:get

POST /v2/{project_id}/desktops/detach

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

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
desktop_ids	No	Array of strings	Desktop ID list, which cannot be empty. Desktops in the hibernated state cannot be unbound.
shutoff_after_detach	No	Boolean	Whether to shut down the desktop after unbinding.

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
failed_operation_list	Array of VmOperateResult objects	Desktops on which operations failed.
job_id	String	Task ID. For desktops in a desktop pool, the specific value of job_id is returned. For common desktops, the value of this parameter is empty.
success_job_ids	Array of strings	Job IDs of successful internal service operations.

**Table 4** VmOperateResult
Parameter	Type	Description
desktop_id	String	Desktop ID.
desktop_name	String	Desktop name.
error_code	String	Error code.
error_msg	String	Cause of the operation failure.

Status code: 400

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

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

Status code: 403

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

**Table 8** 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 9** 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 10** 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.

POST /v2/0bec5db98280d2d02fd6c00c2de791ce/desktops/detach

{
  "desktop_ids" : [ "string" ]
}

Status code: 200

Normal.

{
  "failed_operation_list" : [ ]
}

Status Code	Description
200	Normal.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
409	Operation conflict.
500	An internal service error occurred. For details about the error code, see the error code description.