openbmc_project/User/README.md

1 # User Management
5 User Manager service exposes D-Bus methods for user management operations.
7 ### User Manager Interface
9 User manager interface `xyz.openbmc_project.User.Manager` provides following
12 #### xyz.openbmc_project.User.Manager interface
16 - CreateUser - To create new user to the system.
17 - RenameUser - To rename existing user to new name in the system.
21 - AllGroups - To list all the groups supported in the system.
22 - AllPrivileges - To list all the privileges supported in the system.
26 - UserRenamed - Signal sent out when user is renamed in the system.
28 #### xyz.openbmc_project.User.AccountPolicy interface
32 - MaxLoginAttemptBeforeLockout - Permissible attempt before locking out the user
34 - AccountUnlockTimeout - Timeout (in seconds) to unlock the account after a
36 - MinPasswordLength - Minimum password length, which can be set.
37 - RememberOldPasswordTimes – Number of times old password shouldn’t be allowed
38   when updating password for the user.
42 User manager daemon, will create user objects for every user existing in the
43 system under object path `/xyz/openbmc_project/user/<user name>`. Each user
44 object can be handled through 'org.freedesktop.DBus.ObjectManager'. User object
47 #### xyz.openbmc_project.User.Attributes interface
51 - UserPrivilege - Privilege of the user.
52 - UserGroups - Groups to which the user belongs.
53 - UserEnabled - User enabled state.
54 - UserLockedForFailedAttempt - Locked or unlocked state of the user account.
60 - Delete - To delete the user object in the system.
66 out password through D-Bus.