Help Center/ KooDrive/ API Reference/ API/ Group Management/ Deleting Members from a User Group
Updated on 2024-07-30 GMT+08:00
View PDF
Share

Deleting Members from a User Group

Function

Delete members from a user group.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

group_id

Yes

String

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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

userIds

Yes

Array of strings

User ID list.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

code

String

Response code.

msg

String

Response information.

status

Integer

Response status. 0: all successful; 1: partially successful; 2: all failed.

subResponseList

Array of MemberResponse objects

Sub-response list.
Table 5 MemberResponse

Parameter

Type

Description

code

String

Response code.

message

String

Response code.

userId

String

Member user ID.

Example Requests

Deletes users from group 369528171409614001.

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

Authorization:Bearer+c69b0f40334782d560bb154032cf22ef43d671843c4ffbad


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

Example Responses

Status code: 200

Response for deleting users.

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

Status Codes

Status Code

Description

200

Response for deleting users.
Parent topic: Group Management