On this page

Show all

Help Center/ KooDrive/ API Reference/ API/ Group Management/ Adding Members to a User Group

Adding Members to a User Group

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

View PDF

Function

Add members to a user group.

URI

POST /koodrive/ose/v1/usergroups/{group_id}/members/batchAdd

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
group_id	Yes	String	Group ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Authorization	Yes	String	Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.
X-Traceid	No	String	Message log trace ID. The value contains 58 bits.
language	No	String	Language code, which complies with the internationalization specifications. For example, en-US indicates English (United States). English (United States) is used by default.
X-User-Id	Yes	String	User ID, which is used for app authentication.
X-Date	Yes	String	Date, which is used for app authentication.
Host	Yes	String	Address, which is used for app authentication.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
amendModRoles	Yes	Array of AmendModRole objects	User permission information to be updated.

**Table 4** AmendModRole
Parameter	Mandatory	Type	Description
userId	Yes	Long	User ID.
template	Yes	Long	Permission template ID. For an anonymous template, set this parameter to -1. (This parameter is optional when members are added to or deleted from a user group in batches.)
capabilities	No	Capabilities object	Permission value (transferred when a template is customized).

**Table 5** Capabilities
Parameter	Mandatory	Type	Description
addChildNodePermission	Yes	Boolean	Permission to create a file or folder. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.
copyPermission	Yes	Boolean	Copy permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.
deletePermission	Yes	Boolean	Delete permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.
downloadPermission	Yes	Boolean	Download permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.
editPermission	Yes	Boolean	Edit permissions. true: granted; false: not granted (editing is not supported.)
listChildNodePermission	Yes	Boolean	Permission to view the list. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.
removeChildNodePermission	Yes	Boolean	Move permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.
renameFilePermission	Yes	Boolean	Rename permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.
shareFilePermission	Yes	Boolean	Share permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.
uploadPermission	Yes	Boolean	Upload permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.
viewPermission	Yes	Boolean	Preview permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
code	Integer	Response code.
msg	String	Response information.
status	Integer	Response status. 0: all successful; 1: partially successful; 2: all failed.
failedList	Array of strings	Failed response list.

Example Requests

Adds users to group 369528171409614001.

POST /koodrive/ose/v1/usergroups/369528171409614001/members/batchAdd

Authorization:Bearer+c69b0f40334782d560bb154032cf22ef43d671843c4ffbad

{
  "userIds": ["3432423464657862424","132543141414141414"]
}

Example Responses

Status code: 200

Response for adding users.

{
  "code" : 0,
  "msg" : "OK",
  "id" : "xxx"
}

Status Codes

Status Code	Description
200	Response for adding users.

Parent topic: Group Management

Previous topic: Listing Members in a User Group

Next topic: Deleting Members from a User Group

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot