Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Modifying User Permission Groups in Batches

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

View PDF

Modifying User Permission Groups in Batches

Function

Modifies user permission groups in batches.

Debugging

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

URI

POST /v2/{project_id}/desktops/change-user-privilege-group

**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
desktops	Yes	Array of ChangeUserPrivilegeGroupDesktopInfo objects	Desktop information list.
user_privilege_group	No	String	User permission group to which the desktop user belongs. Desktop users who are not contained in the parameter desktops will belong to this permission group. sudo: Linux administrator group default: default Linux user group administrators: Windows administrator group. Administrators have full access to the desktop and can make any required changes except for forbidden operations. users: standard Windows user group. Standard users can use most software programs and change system settings that do not affect other users.

**Table 3** ChangeUserPrivilegeGroupDesktopInfo
Parameter	Mandatory	Type	Description
desktop_id	Yes	String	ID of the desktop to be modified.
attach_user_infos	No	Array of ChangeUserPrivilegeGroupUserInfo objects	Information about the user whose permission group is to be modified. If this parameter is not transferred for a desktop, the parameter user_privilege_group of the upper-layer application structure is used as the permission group of the user.

**Table 4** ChangeUserPrivilegeGroupUserInfo
Parameter	Mandatory	Type	Description
user_name	Yes	String	Name of the object assigned with a desktop. If type is set to USER, enter the username. If type is set to GROUP, enter the user group name.
user_privilege_group	No	String	User group to which the desktop user belongs. sudo: Linux administrator group default: default Linux user group administrators: Windows administrator group. Administrators have full access to the desktop and can make any required changes except for forbidden operations. users: standard Windows user group. Standard users can use most software programs and change system settings that do not affect other users.
type	Yes	String	Object type. Options: USER: user GROUP: user group

Response Parameters

Status code: 200

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

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
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 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
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 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
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 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
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 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
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 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
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

{
  "desktops" : [ {
    "desktop_id" : "string",
    "attach_user_infos" : [ {
      "user_name" : "string",
      "user_privilege_group" : "string",
      "type" : "user"
    } ]
  } ]
}

Example Responses

Status code: 200

Normal.

{
  "job_id" : "string"
}

Status Codes

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, see the error code description.