1# User Management
2
3## Overview
4User Manager service exposes D-Bus methods for user management operations.
5
6### User Manager Interface
7User manager interface `xyz.openbmc_project.User.Manager` provides following
8methods, properties and signals.
9
10#### xyz.openbmc_project.User.Manager interface
11##### methods
12* CreateUser - To create new user to the system.
13* RenameUser - To rename existing user to new name in the system.
14
15##### properties
16* AllGroups - To list all the groups supported in the system.
17* AllPrivileges  - To list all the privileges supported in the system.
18
19##### signals
20* UserRenamed - Signal sent out when user is renamed in the system.
21
22#### xyz.openbmc_project.User.AccountPolicy interface
23##### properties
24* MaxLoginAttemptBeforeLockout - Permissible attempt before locking out the
25user for failed login attempts.
26* AccountUnlockTimeout - Timeout (in seconds) to unlock the account after a
27lockout.
28* MinPasswordLength - Minimum password length, which can be set.
29* RememberOldPasswordTimes – Number of times old password shouldn’t be allowed
30when updating password for the user.
31
32### Users Interface
33User manager daemon, will create user objects for every user existing
34in the system under object path `/xyz/openbmc_project/user/<user name>`.
35Each user object can be handled through 'org.freedesktop.DBus.ObjectManager'.
36User object will expose following properties and methods.
37
38#### xyz.openbmc_project.User.Attributes interface
39##### properties
40* UserPrivilege - Privilege of the user.
41* UserGroups - Groups to which the user belongs.
42* UserEnabled - User enabled state.
43* UserLockedForFailedAttempt - Locked or unlocked state of the user account.
44
45#### xyz.openbmc_project.Object.Delete
46#### methods
47* Delete - To delete the user object in the system.
48
49##Note
50This interface doesn't provide ways to set / update password. The same must
51be set / updated through pam_chauthtok() (PAM modules). This is to avoid
52sending out password through D-Bus.
53