WickrAdminAPI / Client / batch_reset_devices_for_user

batch_reset_devices_for_user¶

WickrAdminAPI.Client.batch_reset_devices_for_user(**kwargs)¶

Resets multiple devices for a specific user in a Wickr network. This operation forces the selected devices to log out and requires users to re-authenticate, which is useful for security purposes or when devices need to be revoked.

Request Syntax

response = client.batch_reset_devices_for_user(
    networkId='string',
    userId='string',
    appIds=[
        'string',
    ],
    clientToken='string'
)

Parameters:

networkId (string) –
[REQUIRED]

The ID of the Wickr network containing the user whose devices will be reset.
userId (string) –
[REQUIRED]

The ID of the user whose devices will be reset.
appIds (list) –
[REQUIRED]

A list of application IDs identifying the specific devices to be reset for the user. Maximum 50 devices per batch request.
- (string) –
clientToken (string) –
A unique identifier for this request to ensure idempotency.

This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- message (string) –
  
  A message indicating the overall result of the batch device reset operation.
- successful (list) –
  
  A list of application IDs that were successfully reset.
  - (dict) –
    
    Contains information about a device that was successfully processed in a batch device operation.
    - appId (string) –
      
      The application ID of the device that was successfully processed.
- failed (list) –
  
  A list of device reset attempts that failed, including error details explaining why each device could not be reset.
  - (dict) –
    
    Contains error information for a device operation that failed in a batch device request.
    - field (string) –
      
      The field that caused the error.
    - reason (string) –
      
      A description of why the device operation failed.
    - appId (string) –
      
      The application ID of the device that failed to be processed.

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