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

Updated on 2024-07-30 GMT+08:00

View PDF

Creating a User Group

Function

Create a user group.

URI

POST /koodrive/ose/v1/usergroups

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.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
groupName	Yes	String	User group name, which cannot contain <>\|:"*?/\ or emojis. The value cannot be two periods (..), a period (.), or a space. Minimum: 1 Maximum: 30
sourceType	Yes	Integer	User group type.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
code	String	Error code.
msg	String	Error description.
failedList	Array of strings	Failure list.

Example Requests

Creates a group.

POST /koodrive/ose/v1/usergroups

Authorization:Bearer+c69b0f40334782d560bb154032cf22ef43d671843c4ffbad

{
  "capacity": 1,
  "type": 0
}

Example Responses

Status code: 200

Basic response. For a successful response, the ID of the created user group is returned. For an error response, only the error code and error information are returned.

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

Status Codes

Status Code	Description
200	Basic response. For a successful response, the ID of the created user group is returned. For an error response, only the error code and error information are returned.