| Richard Marian Thomaiyar | 05375b1 | 2018-05-24 10:33:27 +0530 | [diff] [blame] | 1 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 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. |
| Richard Marian Thomaiyar | 05375b1 | 2018-05-24 10:33:27 +0530 | [diff] [blame] | 5 | |
| 6 | properties: |
| 7 | - name: UserGroups |
| 8 | type: array[string] |
| 9 | description: > |
| 10 | Groups to which the user belong. |
| Ratan Gupta | 0e6d655 | 2018-11-03 12:28:06 +0530 | [diff] [blame] | 11 | errors: |
| 12 | - xyz.openbmc_project.Common.Error.InternalFailure |
| Richard Marian Thomaiyar | 05375b1 | 2018-05-24 10:33:27 +0530 | [diff] [blame] | 13 | |
| 14 | - name: UserPrivilege |
| 15 | type: string |
| 16 | description: > |
| Chalapathi | da67a61 | 2020-05-11 20:03:44 +0000 | [diff] [blame] | 17 | Privilege of the user. Acceptable values of the system are listed |
| 18 | under AllPrivileges property under User.Manager interface. |
| Ratan Gupta | 0e6d655 | 2018-11-03 12:28:06 +0530 | [diff] [blame] | 19 | errors: |
| 20 | - xyz.openbmc_project.Common.Error.InternalFailure |
| Chalapathi | da67a61 | 2020-05-11 20:03:44 +0000 | [diff] [blame] | 21 | - xyz.openbmc_project.Common.Error.InvalidArgument |
| Richard Marian Thomaiyar | 05375b1 | 2018-05-24 10:33:27 +0530 | [diff] [blame] | 22 | |
| 23 | - name: UserEnabled |
| 24 | type: boolean |
| 25 | description: > |
| 26 | Enabled or disabled state of the user. |
| Ratan Gupta | 0e6d655 | 2018-11-03 12:28:06 +0530 | [diff] [blame] | 27 | errors: |
| 28 | - xyz.openbmc_project.Common.Error.InternalFailure |
| Richard Marian Thomaiyar | 0248630 | 2018-07-16 00:29:50 +0530 | [diff] [blame] | 29 | |
| 30 | - name: UserLockedForFailedAttempt |
| 31 | type: boolean |
| 32 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 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. |
| Ratan Gupta | 0e6d655 | 2018-11-03 12:28:06 +0530 | [diff] [blame] | 39 | errors: |
| 40 | - xyz.openbmc_project.Common.Error.InternalFailure |
| Joseph Reynolds | e375cad | 2020-04-10 17:22:06 -0500 | [diff] [blame] | 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: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 56 | True when the user's password must be changed before access should be |
| 57 | granted. |
| Joseph Reynolds | e375cad | 2020-04-10 17:22:06 -0500 | [diff] [blame] | 58 | errors: |
| 59 | - xyz.openbmc_project.Common.Error.InternalFailure |