:doc:`WickrAdminAPI <../../wickr>` / Client / batch_delete_user

*****************
batch_delete_user
*****************



.. py:method:: 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.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wickr-2024-02-01/BatchDeleteUser>`_  


  **Request Syntax**
  ::

    response = client.batch_delete_user(
        networkId='string',
        userIds=[
            'string',
        ],
        clientToken='string'
    )
    
  :type networkId: string
  :param networkId: **[REQUIRED]** 

    The ID of the Wickr network from which users will be deleted.

    

  
  :type userIds: list
  :param userIds: **[REQUIRED]** 

    A list of user IDs identifying the users to be deleted from the network. Maximum 50 users per batch request.

    

  
    - *(string) --* 

    

  :type clientToken: string
  :param clientToken: 

    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.

  
  
  :rtype: 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**
  
  *   :py:class:`WickrAdminAPI.Client.exceptions.ValidationError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.BadRequestError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.ResourceNotFoundError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.ForbiddenError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.UnauthorizedError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.InternalServerError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.RateLimitError`

  