WickrAdminAPI / Client / batch_lookup_user_uname

batch_lookup_user_uname¶

WickrAdminAPI.Client.batch_lookup_user_uname(**kwargs)¶

Looks up multiple user usernames from their unique username hashes (unames). This operation allows you to retrieve the email addresses associated with a list of username hashes.

Request Syntax

response = client.batch_lookup_user_uname(
    networkId='string',
    unames=[
        'string',
    ],
    clientToken='string'
)

Parameters:

networkId (string) –
[REQUIRED]

The ID of the Wickr network where the users will be looked up.
unames (list) –
[REQUIRED]

A list of username hashes (unames) to look up. Each uname is a unique identifier for a user’s username. Maximum 50 unames 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': [
        {
            'uname': 'string',
            'username': 'string'
        },
    ],
    'failed': [
        {
            'field': 'string',
            'reason': 'string',
            'uname': 'string'
        },
    ]
}

Response Structure

(dict) –
- message (string) –
  
  A message indicating the overall result of the batch lookup operation.
- successful (list) –
  
  A list of successfully resolved username hashes with their corresponding email addresses.
  - (dict) –
    
    Contains information about a username hash that was successfully resolved in a batch uname lookup operation.
    - uname (string) –
      
      The username hash that was successfully resolved.
    - username (string) –
      
      The email address or username corresponding to the username hash.
- failed (list) –
  
  A list of username hash lookup attempts that failed, including error details explaining why each lookup failed.
  - (dict) –
    
    Contains error information for a username hash lookup that failed in a batch uname lookup request.
    - field (string) –
      
      The field that caused the error.
    - reason (string) –
      
      A description of why the username hash lookup failed.
    - uname (string) –
      
      The username hash that failed to be looked up.

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