blob: 24df81ba83299e298e623ae48db8c65dc76a4e04 [file] [log] [blame]
Richard Marian Thomaiyar05375b12018-05-24 10:33:27 +05301description: >
2 Provides user objects, their properties.
3 As communication to this service is done through authenticated
4 & authorized session, there won't be any validation for the both.
5
6properties:
7 - name: UserGroups
8 type: array[string]
9 description: >
10 Groups to which the user belong.
Ratan Gupta0e6d6552018-11-03 12:28:06 +053011 errors:
12 - xyz.openbmc_project.Common.Error.InternalFailure
Richard Marian Thomaiyar05375b12018-05-24 10:33:27 +053013
14 - name: UserPrivilege
15 type: string
16 description: >
17 Privilege of the user.
Ratan Gupta0e6d6552018-11-03 12:28:06 +053018 errors:
19 - xyz.openbmc_project.Common.Error.InternalFailure
Richard Marian Thomaiyar05375b12018-05-24 10:33:27 +053020
21 - name: UserEnabled
22 type: boolean
23 description: >
24 Enabled or disabled state of the user.
Ratan Gupta0e6d6552018-11-03 12:28:06 +053025 errors:
26 - xyz.openbmc_project.Common.Error.InternalFailure
Richard Marian Thomaiyar02486302018-07-16 00:29:50 +053027
28 - name: UserLockedForFailedAttempt
29 type: boolean
30 description: >
31 Locked or unlocked state of the user. After repeated failed
32 login attempt (configured through MaxLoginAttemptBeforeLockout),
33 locked out user can be unlocked manually by setting false to
34 this property. This property will return true if user is locked
35 out user. AccountUnlockTimeout property can be configured to unlock
36 the user after a timeout.
Ratan Gupta0e6d6552018-11-03 12:28:06 +053037 errors:
38 - xyz.openbmc_project.Common.Error.InternalFailure
Joseph Reynoldse375cad2020-04-10 17:22:06 -050039
40 - name: RemoteUser
41 type: boolean
42 flags:
43 - const
44 description: >
45 False for local users.
46 errors:
47 - xyz.openbmc_project.Common.Error.InternalFailure
48
49 - name: UserPasswordExpired
50 type: boolean
51 flags:
52 - const
53 description: >
54 True when the user's password must be changed before access should
55 be granted.
56 errors:
57 - xyz.openbmc_project.Common.Error.InternalFailure