On this page

Show all

Help Center/ KooDrive/ API Reference/ API/ Space Management/ Creating a Group Space

Creating a Group Space

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

View PDF

Function

Create a group space.

URI

POST /koodrive/ose/v1/space/group

Request Parameters

**Table 1** 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 2** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Space name.
iconUrl	No	String	Space profile picture.
capacity	No	Integer	Space size.
addGroupUsers	Yes	Array of AddGroupUsers objects	List of users to be added to the group.

**Table 3** AddGroupUsers
Parameter	Mandatory	Type	Description
userId	Yes	String	User ID.
template	Yes	Long	Permissions template ID. For a custom template, the value is -1.
capabilities	No	Capabilities object	Permissions value (transferred when a template is customized).

**Table 4** 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 5** Response body parameters
Parameter	Type	Description
code	Integer	Error code.
msg	String	Error description.
failedList	Array of strings	Failure list.
id	String	Space ID.

Example Requests

Creates a space of 20 GB for a group.

POST /koodrive/ose/v1/space/

Authorization:Bearer+10f88**********4791e9ff

{
    "name": "API Demo",
    "capacity": 20,
    "iconUrl": "1",
    "userIds": []
}

Example Responses

Status code: 200

Basic response. Only the error code and error information are returned.

{
  "id" : "xxx",
  "failedList" : [ ],
  "code" : 0,
  "msg" : "OK"
}

Status Codes

Status Code	Description
200	Basic response. Only the error code and error information are returned.

Parent topic: Space Management

Previous topic: Querying Information About a Team Space

Next topic: Dismissing a Team Space

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