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