summaryrefslogtreecommitdiffstats
path: root/xyz/openbmc_project/User/Password.interface.yaml
blob: 24697a38c7299e8b29d2016936dd7d2f1defc661 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
description: >
    Implement to provide user password set functionality. Since this
    needs an authenticated session, there is no need of old password.
    User ID is part of the dbus object.
methods:
    - name: SetPassword
      description: >
          Set the user password. If the user already had a password, it will
          be updated, else sets the password.

          InsufficientPermission error doing so would mean that, the caller
          does not have required permission to update the password.

          InternalFailure error would mean that, caller had required
          permissions, but, there was a software error.
          Errorlog metadata would need to be looked into when this happens.
          Re-try once on this error and if that fails, do not try anymore.
      parameters:
        - name: NewPassword
          type: string
          description: >
              new password string
      errors:
        - xyz.openbmc_project.Common.Error.InternalFailure
        - xyz.openbmc_project.Common.Error.InsufficientPermission

# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4
OpenPOWER on IntegriCloud