Binding a User to a Desktop Pool_Desktop Pools_Workspace APIs_API Reference

Function

Binds a user to a desktop pool.

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:desktopPools:attachUser

Write

desktopPool *

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:desktopPools:attachUser	Write	desktopPool *	-	-	-

URI

POST /v2/{project_id}/desktop-pools/{pool_id}/attach

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
pool_id	Yes	String	Specifies the desktop pool ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
username	Yes	String	Username.
domain_name	No	String	Domain name.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
type	String	CREATING: The desktop is being created. WAITING: The task is in the queue of the dynamic pool. EXCEEDED: The number of desktops in the static pool has reached the maximum. ASSIGNING: An idle desktop is being assigned. RESETTING: The desktop is being reset.
job_id	String	Task ID.

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

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

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

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

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

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

Example Requests

POST /v2/0bec5db98280d2d02fd6c00c2de791ce/desktop-pools/a130ab3a-72bf-4b71-baa9-af4987c8e338/attach

{
  "username" : "user01",
  "domain_name" : "domain01"
}

Example Responses

Status code: 200

{
  "job_id" : "abc85365-0b2e-4b4f-a091-f7db72072d4b"
}

Status Codes

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

Error Codes

See Error Codes.

Binding a User to a Desktop Pool