Help Center/ Distributed Message Service for Kafka/ API Reference/ APIs V2 (Recommended)/ User Management/ Deleting Users in Batches
Updated on 2022-09-15 GMT+08:00
View PDF

Deleting Users in Batches

Function

This API is used to delete multiple users of a Kafka instance.

URI

PUT /v2/{project_id}/instances/{instance_id}/users

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

action

No

String

Deletion type. Currently, only delete is supported.

users

No

Array of strings

User list.

Response Parameters

None

Example Requests

Deleting users in batches.

PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/users

{
  "action" : "delete",
  "users" : [ "testuser" ]
}

Example Responses

None

Status Codes

Status Code

Description

204

The deletion is successful.

Error Codes

See Error Codes.

Parent topic: User Management