WickrAdminAPI / Client / list_guest_users

list_guest_users¶

WickrAdminAPI.Client.list_guest_users(**kwargs)¶

Retrieves a paginated list of guest users who have communicated with your Wickr network. Guest users are external users from federated networks who can communicate with network members.

Request Syntax

response = client.list_guest_users(
    networkId='string',
    maxResults=123,
    sortDirection='ASC'|'DESC',
    sortFields='string',
    username='string',
    billingPeriod='string',
    nextToken='string'
)

Parameters:

networkId (string) –
[REQUIRED]

The ID of the Wickr network from which to list guest users.
maxResults (integer) – The maximum number of guest users to return in a single page. Valid range is 1-100. Default is 10.
sortDirection (string) – The direction to sort results. Valid values are ‘ASC’ (ascending) or ‘DESC’ (descending). Default is ‘DESC’.
sortFields (string) – The field to sort guest users by. Accepted values include ‘username’ and ‘billingPeriod’.
username (string) – Filter results to only include guest users with usernames matching this value.
billingPeriod (string) – Filter results to only include guest users from this billing period (e.g., ‘2024-01’).
nextToken (string) – The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'guestlist': [
        {
            'billingPeriod': 'string',
            'username': 'string',
            'usernameHash': 'string'
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  The token to use for retrieving the next page of results. If this is not present, there are no more results.
- guestlist (list) –
  
  A list of guest user objects within the current page.
  - (dict) –
    
    Represents a guest user who has accessed the network from a federated Wickr network.
    - billingPeriod (string) –
      
      The billing period when this guest user accessed the network (e.g., ‘2024-01’).
    - username (string) –
      
      The username of the guest user.
    - usernameHash (string) –
      
      The unique username hash identifier for the guest user.

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