Bulk Delete Users
Deletes multiple users in one request. The users are logically deleted.
Request URL
DELETE {base_url}/uc-cconfig/api/v1/users/batchRequest parameters
- Headers
-
Parameter Required Type Description Authorization Yes String The access token used for authentication. Format: Bearer
{access_token}.x-tenant-code Yes String The tenant name. Note: You can obtain tenant name using the Query Tenants interface.
- Body parameters
-
Parameter Required Type Description ids Yes Array<String> The list of IDs of the users to delete. You can obtain the IDs using the Search Users interface.
Response parameters
| Parameter | Type | Description |
|---|---|---|
| requestId | String | The unique ID of the request, which can be used to quickly locate the request. |
| code | String | The HTTP status code of the request.
|
| message | String | The status message of the request. |
| detailMessage | String | The detailed error information. When the request is successful, this parameter returns empty. |
| result | Object<Deletion_Result> | The deletion result. |
- Deletion_Result
-
Parameter Type Description successCount Integer The number of users deleted successfully. failedCount Integer The number of users that fail to be deleted. failures Array<Failure_Item> The list of users that fail to be deleted, with failure reasons.
- Failure_Item
-
Parameter Type Description id String The ID of the user that fails to be deleted. errorCode String The error code of the failure. errorMessage String The description of the failure reason.