| Vishwanatha Subbanna | 3284799 | 2017-08-29 17:36:07 +0530 | [diff] [blame] | 1 | description: > |
| 2 | Implement to provide user password set functionality. Since this |
| 3 | needs an authenticated session, there is no need of old password. |
| 4 | User ID is part of the dbus object. |
| 5 | methods: |
| 6 | - name: SetPassword |
| 7 | description: > |
| 8 | Set the user password. If the user already had a password, it will |
| 9 | be updated, else sets the password. |
| 10 | |
| 11 | InsufficientPermission error doing so would mean that, the caller |
| 12 | does not have required permission to update the password. |
| 13 | |
| 14 | InternalFailure error would mean that, caller had required |
| 15 | permissions, but, there was a software error. |
| 16 | Errorlog metadata would need to be looked into when this happens. |
| 17 | Re-try once on this error and if that fails, do not try anymore. |
| 18 | parameters: |
| 19 | - name: NewPassword |
| 20 | type: string |
| 21 | description: > |
| 22 | new password string |
| 23 | errors: |
| 24 | - xyz.openbmc_project.Common.Error.InternalFailure |
| 25 | - xyz.openbmc_project.Common.Error.InsufficientPermission |
| 26 | |
| 27 | # vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4 |