Help Center/ Workspace/ API Reference/ Workspace APIs/ Tenant Configuration/ Setting Default User Configurations of a Collaborative Desktop

Updated on 2025-07-14 GMT+08:00

View PDF

Setting Default User Configurations of a Collaborative Desktop

Sets default user configurations of a collaborative desktop. (This function is in the open beta test. To use it, contact the administrator.)

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

PUT /v2/{project_id}/share-space/configuration

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

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
config_name	No	String	Configuration name.
config_value	No	String	Configuration value, which is a JSON string. '{"share_space_name":"Collaborative space", "use_share_password": Whether to use the collaboration password: true/false, "allow_anonymous": Whether to join the collaboration anonymously: true/false, "audio_and_video": Whether to use audio,"AUDIO"/"NONE"/"AUDIO_AND_VIDEO","keyboard_mouse_ctl": Whether keyboard and mouse operations can be performed on the desktop: true/false,"anonymous_input_ctrl": Whether to grant the keyboard and mouse input permission to anonymous users: true/false, "is_user_confirm_enabled": Whether a user response is required: true/false,"wait_confirm_time": Waiting time (30-180s)}. '

Status code: 204

Normal.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
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.
error_msg	String	Error description.
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.
error_msg	String	Error description.
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.
error_msg	String	Error description.
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 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

PUT /v2/8a2c3f8e71ed17c60171ed1fbf340000/share-space/configuration

{
  "config_name" : "xxx"
}

None

Status Code	Description
204	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.
500	An internal service error occurred. For details, see the error code description.