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

********
get_user
********



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

  

  Retrieves detailed information about a specific user in a Wickr network, including their profile, status, and activity history.

  

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


  **Request Syntax**
  ::

    response = client.get_user(
        networkId='string',
        userId='string',
        startTime=datetime(2015, 1, 1),
        endTime=datetime(2015, 1, 1)
    )
    
  :type networkId: string
  :param networkId: **[REQUIRED]** 

    The ID of the Wickr network containing the user.

    

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

    The unique identifier of the user to retrieve.

    

  
  :type startTime: datetime
  :param startTime: 

    The start time for filtering the user's last activity. Only activity after this timestamp will be considered. Time is specified in epoch seconds.

    

  
  :type endTime: datetime
  :param endTime: 

    The end time for filtering the user's last activity. Only activity before this timestamp will be considered. Time is specified in epoch seconds.

    

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

    
    ::

      {
          'userId': 'string',
          'firstName': 'string',
          'lastName': 'string',
          'username': 'string',
          'isAdmin': True|False,
          'suspended': True|False,
          'status': 123,
          'lastActivity': 123,
          'lastLogin': 123,
          'securityGroupIds': [
              'string',
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The unique identifier of the user.

        
      

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

        
      

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

        Indicates whether the user has administrator privileges in the network.

        
      

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

        Indicates whether the user is currently suspended.

        
      

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

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

        
      

      - **lastActivity** *(integer) --* 

        The timestamp of the user's last activity in the network, specified in epoch seconds.

        
      

      - **lastLogin** *(integer) --* 

        The timestamp of the user's last login to the network, specified in epoch seconds.

        
      

      - **securityGroupIds** *(list) --* 

        A list of security group IDs to which the user belongs.

        
        

        - *(string) --* 
    
  
  **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`

  