WickrAdminAPI / Client / batch_delete_user

batch_delete_user¶

WickrAdminAPI.Client.batch_delete_user(**kwargs)¶

Deletes multiple users from a specified Wickr network. This operation permanently removes user accounts and their associated data from the network.

Request Syntax

response = client.batch_delete_user(
    networkId='string',
    userIds=[
        'string',
    ],
    clientToken='string'
)

Parameters:

networkId (string) –
[REQUIRED]

The ID of the Wickr network from which users will be deleted.
userIds (list) –
[REQUIRED]

A list of user IDs identifying the users to be deleted from the network. Maximum 50 users per batch request.
- (string) –
clientToken (string) –
A unique identifier for this request to ensure idempotency. If you retry a request with the same client token, the service will return the same response without attempting to delete users again.

This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'message': 'string',
    'successful': [
        {
            'userId': 'string'
        },
    ],
    'failed': [
        {
            'field': 'string',
            'reason': 'string',
            'userId': 'string'
        },
    ]
}

Response Structure

(dict) –
- message (string) –
  
  A message indicating the overall result of the batch deletion operation.
- successful (list) –
  
  A list of user IDs that were successfully deleted from the network.
  - (dict) –
    
    Contains information about a user that was successfully processed in a batch user operation.
    - userId (string) –
      
      The user ID that was successfully processed.
- failed (list) –
  
  A list of user deletion attempts that failed, including error details explaining why each user could not be deleted.
  - (dict) –
    
    Contains error information for a user operation that failed in a batch user request.
    - field (string) –
      
      The field that caused the error.
    - reason (string) –
      
      A description of why the user operation failed.
    - userId (string) –
      
      The user ID associated with the failed operation.

Exceptions

WickrAdminAPI.Client.exceptions.ValidationError
WickrAdminAPI.Client.exceptions.BadRequestError
WickrAdminAPI.Client.exceptions.ResourceNotFoundError
WickrAdminAPI.Client.exceptions.ForbiddenError
WickrAdminAPI.Client.exceptions.UnauthorizedError
WickrAdminAPI.Client.exceptions.InternalServerError
WickrAdminAPI.Client.exceptions.RateLimitError