blob: 31d9939004eac10237eb67e702dd42ed9872eb69 [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.
11
12 - name: UserPrivilege
13 type: string
14 description: >
15 Privilege of the user.
16
17 - name: UserEnabled
18 type: boolean
19 description: >
20 Enabled or disabled state of the user.
Richard Marian Thomaiyar02486302018-07-16 00:29:50 +053021
22 - name: UserLockedForFailedAttempt
23 type: boolean
24 description: >
25 Locked or unlocked state of the user. After repeated failed
26 login attempt (configured through MaxLoginAttemptBeforeLockout),
27 locked out user can be unlocked manually by setting false to
28 this property. This property will return true if user is locked
29 out user. AccountUnlockTimeout property can be configured to unlock
30 the user after a timeout.
Richard Marian Thomaiyar05375b12018-05-24 10:33:27 +053031# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4