openbmc/phosphor-user-manager/users.hpp

8 //      http://www.apache.org/licenses/LICENSE-2.0
22 #include <xyz/openbmc_project/User/Attributes/server.hpp>
23 #include <xyz/openbmc_project/User/MultiFactorAuthConfiguration/server.hpp>
24 #include <xyz/openbmc_project/User/TOTPAuthenticator/server.hpp>
27 namespace user  namespace
31 using UsersIface = Base::User::server::Attributes;
33 using TOTPAuthenticatorIface = Base::User::server::TOTPAuthenticator;
37 using MultiFactorAuthType = sdbusplus::common::xyz::openbmc_project::user::
40     sdbusplus::common::xyz::openbmc_project::user::MultiFactorAuthConfiguration;
41 // Place where all user objects has to be created
42 constexpr auto usersObjPath = "/xyz/openbmc_project/user";
47  *  @brief Lists User objects and it's properties
61      *  @param[in] bus  - sdbusplus handler
62      *  @param[in] path - D-Bus path
63      *  @param[in] groups - users group list
64      *  @param[in] priv - users privilege
65      *  @param[in] enabled - user enabled state
66      *  @param[in] parent - user manager - parent object
72     /** @brief delete user method.
73      *  This method deletes the user as requested
78     /** @brief update user privilege
80      *  @param[in] value - User privilege
88     /** @brief lists user privilege
93     /** @brief update user groups
95      *  @param[in] value - User groups
100     /** @brief list user groups
105     /** @brief lists user enabled state
112     /** @brief update user enabled state
114      *  @param[in] value - bool value
118     /** @brief lists user locked state for failed attempt
123     /** @brief unlock user locked state for failed attempt
125      * @param[in]: value - false - unlock user account, true - no action taken
129     /** @brief indicates if the user's password is expired
154 } // namespace user