:doc:`WickrAdminAPI <../../wickr>` / Paginator / ListUsers

*********
ListUsers
*********



.. py:class:: WickrAdminAPI.Paginator.ListUsers

  ::

    
    paginator = client.get_paginator('list_users')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`WickrAdminAPI.Client.list_users`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          networkId='string',
          sortFields='string',
          sortDirection='ASC'|'DESC',
          firstName='string',
          lastName='string',
          username='string',
          status=123,
          groupId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type networkId: string
    :param networkId: **[REQUIRED]** 

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

      

    
    :type sortFields: string
    :param sortFields: 

      The fields to sort users by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', 'lastName', 'status', and 'groupId'.

      

    
    :type sortDirection: string
    :param sortDirection: 

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

      

    
    :type firstName: string
    :param firstName: 

      Filter results to only include users with first names matching this value.

      

    
    :type lastName: string
    :param lastName: 

      Filter results to only include users with last names matching this value.

      

    
    :type username: string
    :param username: 

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

      

    
    :type status: integer
    :param status: 

      Filter results to only include users with this status (1 for pending, 2 for active).

      

    
    :type groupId: string
    :param groupId: 

      Filter results to only include users belonging to this security group.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'users': [
                {
                    'userId': 'string',
                    'firstName': 'string',
                    'lastName': 'string',
                    'username': 'string',
                    'securityGroups': [
                        'string',
                    ],
                    'isAdmin': True|False,
                    'suspended': True|False,
                    'status': 123,
                    'otpEnabled': True|False,
                    'scimId': 'string',
                    'type': 'string',
                    'cell': 'string',
                    'countryCode': 'string',
                    'challengeFailures': 123,
                    'isInviteExpired': True|False,
                    'isUser': True|False,
                    'inviteCode': 'string',
                    'codeValidation': True|False,
                    'uname': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **users** *(list) --* 

          A list of user objects matching the specified filters and within the current page.

          
          

          - *(dict) --* 

            Represents a user account in a Wickr network with detailed profile information, status, security settings, and authentication details.

             

            .. note::

              

              codeValidation, inviteCode and inviteCodeTtl are restricted to networks under preview only.

              

            
            

            - **userId** *(string) --* 

              The unique identifier for the user within the network.

              
            

            - **firstName** *(string) --* 

              The first name of the user.

              
            

            - **lastName** *(string) --* 

              The last name of the user.

              
            

            - **username** *(string) --* 

              The email address or username of the user. For bots, this must end in 'bot'.

              
            

            - **securityGroups** *(list) --* 

              A list of security group IDs to which the user is assigned, determining their permissions and feature access.

              
              

              - *(string) --* 
          
            

            - **isAdmin** *(boolean) --* 

              Indicates whether the user has administrator privileges in the network.

              
            

            - **suspended** *(boolean) --* 

              Indicates whether the user is currently suspended and unable to access the network.

              
            

            - **status** *(integer) --* 

              The current status of the user (1 for pending invitation, 2 for active).

              
            

            - **otpEnabled** *(boolean) --* 

              Indicates whether one-time password (OTP) authentication is enabled for the user.

              
            

            - **scimId** *(string) --* 

              The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used.

              
            

            - **type** *(string) --* 

              The descriptive type of the user account (e.g., 'user').

              
            

            - **cell** *(string) --* 

              The phone number minus country code, used for cloud deployments.

              
            

            - **countryCode** *(string) --* 

              The country code for the user's phone number, used for cloud deployments.

              
            

            - **challengeFailures** *(integer) --* 

              The number of failed password attempts for enterprise deployments, used for account lockout policies.

              
            

            - **isInviteExpired** *(boolean) --* 

              Indicates whether the user's email invitation code has expired, applicable to cloud deployments.

              
            

            - **isUser** *(boolean) --* 

              Indicates whether this account is a user (as opposed to a bot or other account type).

              
            

            - **inviteCode** *(string) --* 

              The invitation code for this user, used during registration to join the network.

              
            

            - **codeValidation** *(boolean) --* 

              Indicates whether the user can be verified through a custom invite code.

              
            

            - **uname** *(string) --* 

              The unique identifier for the user.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    