xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/User/Attributes.interface.yaml (revision 8a248c727a1ecadef4916e5acc5a3858d71c9f24)
1b1b4d261SWilliam A. Kennington IIIdescription: >
2a1347418SPatrick Williams    Provides user objects, their properties. As communication to this service is
3a1347418SPatrick Williams    done through authenticated & authorized session, there won't be any
4a1347418SPatrick 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: >
33a1347418SPatrick Williams          Locked or unlocked state of the user. After repeated failed login
34a1347418SPatrick Williams          attempt (configured through MaxLoginAttemptBeforeLockout), locked out
35a1347418SPatrick Williams          user can be unlocked manually by setting false to this property. This
36a1347418SPatrick Williams          property will return true if user is locked out user.
37a1347418SPatrick Williams          AccountUnlockTimeout property can be configured to unlock the user
38a1347418SPatrick 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: >
56a1347418SPatrick Williams          True when the user's password must be changed before access should be
57a1347418SPatrick Williams          granted.
58b1b4d261SWilliam A. Kennington III      errors:
59b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
604028755dSDenis Zlobin
61*8a248c72SRavi Teja    - name: TOTPSecretkeyRequired
62*8a248c72SRavi Teja      type: boolean
63*8a248c72SRavi Teja      flags:
64*8a248c72SRavi Teja          - readonly
65*8a248c72SRavi Teja      description: >
66*8a248c72SRavi Teja          True when the user's secret key must be generated before access should
67*8a248c72SRavi Teja          be granted.
68*8a248c72SRavi Teja
694028755dSDenis Zlobin    - name: PasswordExpiration
704028755dSDenis Zlobin      type: uint64
714028755dSDenis Zlobin      default: maxint
724028755dSDenis Zlobin      description: >
734028755dSDenis Zlobin          Indicates the date when this account password expires. Date should be
744028755dSDenis Zlobin          specified in EpochTime format.
75