Help Center/ Workspace/ API Reference/ Workspace APIs/ User Group/ Performing Operations on a User Group

Updated on 2024-01-10 GMT+08:00

View PDF

Performing Operations on a User Group

Function

Perform operations on user groups, such as adding and deleting users.

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}/groups/{group_id}/actions

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
group_id	Yes	String	Desktop user group ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	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.
Content-Type	Yes	String	MIME type of the request body, for example, application/json.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
user_ids	Yes	Array of strings	IDs of users to be added or removed.
op_type	Yes	String	Operation type. ADD: adding DELETE: deleting

Response Parameters

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 405

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 503

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

POST /v2/92c84e5bce3d48d7ab5714a44901eb08/groups/c3cf7492-a696-453e-bafc-e14f52d9f4c8/actions

{
  "user_ids" : [ "995581bc716db75d01719cb0bfe6xxxx" ],
  "op_type" : "ADD"
}

Example Responses

None

Status Codes

Status Code	Description
200	Normal.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	You do not have required permissions.
404	No resource found.
405	The method specified in the request is not allowed.
500	An internal service error occurred. For details about the error code, see the error code description.
503	The service is unavailable.