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

*************************
list_security_group_users
*************************



.. py:method:: WickrAdminAPI.Client.list_security_group_users(**kwargs)

  

  Retrieves a paginated list of users who belong to a specific security group in a Wickr network.

  

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


  **Request Syntax**
  ::

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

    The ID of the Wickr network containing the security group.

    

  
  :type groupId: string
  :param groupId: **[REQUIRED]** 

    The unique identifier of the security group whose users will be listed.

    

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

    

  
  :type maxResults: integer
  :param maxResults: 

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

    

  
  :type sortFields: string
  :param sortFields: 

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

    

  
  :type sortDirection: string
  :param sortDirection: 

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

    

  
  
  :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 belonging to the security group 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) --* 

        The token to use for retrieving the next page of results. If this is not present, there are no more results.

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

  