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

****************
list_guest_users
****************



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

  

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


  **Request Syntax**
  ::

    response = client.list_guest_users(
        networkId='string',
        maxResults=123,
        sortDirection='ASC'|'DESC',
        sortFields='string',
        username='string',
        billingPeriod='string',
        nextToken='string'
    )
    
  :type networkId: string
  :param networkId: **[REQUIRED]** 

    The ID of the Wickr network from which to list guest users.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of guest users to return in a single page. Valid range is 1-100. Default is 10.

    

  
  :type sortDirection: string
  :param sortDirection: 

    The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.

    

  
  :type sortFields: string
  :param sortFields: 

    The field to sort guest users by. Accepted values include 'username' and 'billingPeriod'.

    

  
  :type username: string
  :param username: 

    Filter results to only include guest users with usernames matching this value.

    

  
  :type billingPeriod: string
  :param billingPeriod: 

    Filter results to only include guest users from this billing period (e.g., '2024-01').

    

  
  :type nextToken: string
  :param nextToken: 

    The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

    

  
  
  :rtype: 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**
  
  *   :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`

  