pyanaconda.modules.users.users_interface
========================================

.. py:module:: pyanaconda.modules.users.users_interface


Classes
-------

.. autoapisummary::

   pyanaconda.modules.users.users_interface.UsersInterface


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

.. py:class:: UsersInterface

   Bases: :py:obj:`pyanaconda.modules.common.base.KickstartModuleInterface`


   DBus interface for Users module.


   .. py:method:: connect_signals()

      Connect the signals.



   .. py:property:: CanChangeRootPassword
      :type: Bool


      Can the root password be changed ?

      :return: True, if the root password can the changed, False otherwise


   .. py:property:: RootPassword
      :type: Str


      Root password.

      NOTE: this property should be only temporary and should be
            dropped once the users module itself can configure the root password

      :return: root password (might be crypted)


   .. py:property:: IsRootPasswordCrypted
      :type: Bool


      Is the root password crypted ?

      NOTE: this property should be only temporary and should be
            dropped once the users module itself can configure the root password

      :return: True, if the root password is crypted, otherwise False


   .. py:method:: SetCryptedRootPassword(crypted_root_password)

      Set the root password.

      The password is expected to be provided in already crypted.

      :param crypted_root_password: already crypted root password



   .. py:method:: ClearRootPassword()

      Clear any set root password.



   .. py:property:: IsRootPasswordSet
      :type: Bool


      Is the root password set ?

      :return: True, if the root password is set, otherwise False


   .. py:property:: IsRootAccountLocked
      :type: Bool


      Is the root account locked ?

      :return: True, if the root account is locked, otherwise False


   .. py:property:: RootPasswordSSHLoginAllowed
      :type: Bool


      Is logging in as root via SSH with password allowed ?

      :return: True if root SSH loggin with password is allowed, False otherwise


   .. py:property:: Users
      :type: List[Structure]


      List of users, each describing a single user.

      :return: a list of user describing DBus Structures


   .. py:property:: Groups
      :type: List[Structure]


      List of groups, each describing a single group.

      :return: a list of group describing DBus Structures


   .. py:property:: SshKeys
      :type: List[Structure]


      List of SSH keys, each describing a single SSH key.

      :return: a list of SSH key describing DBus Structures


   .. py:method:: CheckAdminUserExists()

      Reports if at least one admin user exists.

      - an unlocked root account is considered to be an admin user
      - an unlocked user account that is member of the group "wheel"
        is considered to be an admin user

      :return: if at least one admin user exists



   .. py:method:: ConfigureGroupsWithTask()

      Configure user groups via a DBus task.

      :returns: DBus path of the task



   .. py:method:: ConfigureUsersWithTask()

      Configure users via a DBus task.

      :returns: DBus path of the task



   .. py:method:: SetRootPasswordWithTask()

      Set root password via a DBus task.

      :returns: DBus path of the task