:py:mod:`dissect.target.plugins.general.users`
==============================================

.. py:module:: dissect.target.plugins.general.users


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   dissect.target.plugins.general.users.UserDetails
   dissect.target.plugins.general.users.UsersPlugin




.. py:class:: UserDetails


   Bases: :py:obj:`NamedTuple`

   .. py:attribute:: user
      :type: Union[dissect.target.helpers.record.UnixUserRecord, dissect.target.helpers.record.WindowsUserRecord]

      

   .. py:attribute:: home_path
      :type: Optional[dissect.target.helpers.fsutil.TargetPath]

      


.. py:class:: UsersPlugin(target: dissect.target.Target)


   Bases: :py:obj:`dissect.target.plugin.InternalPlugin`

   Internal plugin that provides helper functions for retrieving user details.

   .. py:attribute:: __namespace__
      :value: 'user_details'

      

   .. py:method:: check_compatible() -> None

      Perform a compatibility check with the target.

      This function should return ``None`` if the plugin is compatible with
      the current target (``self.target``). For example, check if a certain
      file exists.
      Otherwise it should raise an ``UnsupportedPluginError``.

      :raises UnsupportedPluginError: If the plugin could not be loaded.


   .. py:method:: find(sid: Optional[str] = None, uid: Optional[str] = None, username: Optional[str] = None, force_case_sensitive: bool = False) -> Optional[UserDetails]

      Find User record matching provided sid, uid or username and return UserDetails object


   .. py:method:: get(user: Union[dissect.target.helpers.record.UnixUserRecord, dissect.target.helpers.record.WindowsUserRecord]) -> UserDetails

      Return additional details about the user


   .. py:method:: all() -> Generator[UserDetails, None, None]

      Return UserDetails objects for all users found


   .. py:method:: all_with_home() -> Generator[UserDetails, None, None]

      Return UserDetails objects for users that have existing directory set as home directory