1b1b4d261SWilliam A. Kennington IIIdescription: >
2*a1347418SPatrick Williams    Provides user objects, their properties. As communication to this service is
3*a1347418SPatrick Williams    done through authenticated & authorized session, there won't be any
4*a1347418SPatrick Williams    validation for the both.
5b1b4d261SWilliam A. Kennington III
6b1b4d261SWilliam A. Kennington IIIproperties:
7b1b4d261SWilliam A. Kennington III    - name: UserGroups
8b1b4d261SWilliam A. Kennington III      type: array[string]
9b1b4d261SWilliam A. Kennington III      description: >
10b1b4d261SWilliam A. Kennington III          Groups to which the user belong.
11b1b4d261SWilliam A. Kennington III      errors:
12b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
13b1b4d261SWilliam A. Kennington III
14b1b4d261SWilliam A. Kennington III    - name: UserPrivilege
15b1b4d261SWilliam A. Kennington III      type: string
16b1b4d261SWilliam A. Kennington III      description: >
17b1b4d261SWilliam A. Kennington III          Privilege of the user. Acceptable values of the system are listed
18b1b4d261SWilliam A. Kennington III          under AllPrivileges property under User.Manager interface.
19b1b4d261SWilliam A. Kennington III      errors:
20b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
21b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InvalidArgument
22b1b4d261SWilliam A. Kennington III
23b1b4d261SWilliam A. Kennington III    - name: UserEnabled
24b1b4d261SWilliam A. Kennington III      type: boolean
25b1b4d261SWilliam A. Kennington III      description: >
26b1b4d261SWilliam A. Kennington III          Enabled or disabled state of the user.
27b1b4d261SWilliam A. Kennington III      errors:
28b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
29b1b4d261SWilliam A. Kennington III
30b1b4d261SWilliam A. Kennington III    - name: UserLockedForFailedAttempt
31b1b4d261SWilliam A. Kennington III      type: boolean
32b1b4d261SWilliam A. Kennington III      description: >
33*a1347418SPatrick Williams          Locked or unlocked state of the user. After repeated failed login
34*a1347418SPatrick Williams          attempt (configured through MaxLoginAttemptBeforeLockout), locked out
35*a1347418SPatrick Williams          user can be unlocked manually by setting false to this property. This
36*a1347418SPatrick Williams          property will return true if user is locked out user.
37*a1347418SPatrick Williams          AccountUnlockTimeout property can be configured to unlock the user
38*a1347418SPatrick Williams          after a timeout.
39b1b4d261SWilliam A. Kennington III      errors:
40b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
41b1b4d261SWilliam A. Kennington III
42b1b4d261SWilliam A. Kennington III    - name: RemoteUser
43b1b4d261SWilliam A. Kennington III      type: boolean
44b1b4d261SWilliam A. Kennington III      flags:
45b1b4d261SWilliam A. Kennington III          - const
46b1b4d261SWilliam A. Kennington III      description: >
47b1b4d261SWilliam A. Kennington III          False for local users.
48b1b4d261SWilliam A. Kennington III      errors:
49b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
50b1b4d261SWilliam A. Kennington III
51b1b4d261SWilliam A. Kennington III    - name: UserPasswordExpired
52b1b4d261SWilliam A. Kennington III      type: boolean
53b1b4d261SWilliam A. Kennington III      flags:
54b1b4d261SWilliam A. Kennington III          - const
55b1b4d261SWilliam A. Kennington III      description: >
56*a1347418SPatrick Williams          True when the user's password must be changed before access should be
57*a1347418SPatrick Williams          granted.
58b1b4d261SWilliam A. Kennington III      errors:
59b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
60