Deleting Users in Batches
Function
This API is used to delete multiple users of a Kafka instance.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/instances/{instance_id}/users
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain it, see Obtaining a Project ID. |
| instance_id | Yes | String | Instance ID. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| action | No | String | Deletion type. Currently, only delete is supported. This parameter is mandatory for deleting a user. |
| users | No | Array of strings | User list. This parameter is mandatory for deleting a user. |
Response Parameters
Status code: 204
The deletion is successful.
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.