summaryrefslogtreecommitdiffstats
path: root/xyz/openbmc_project/User/Attributes.interface.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'xyz/openbmc_project/User/Attributes.interface.yaml')
-rw-r--r--xyz/openbmc_project/User/Attributes.interface.yaml39
1 files changed, 39 insertions, 0 deletions
diff --git a/xyz/openbmc_project/User/Attributes.interface.yaml b/xyz/openbmc_project/User/Attributes.interface.yaml
new file mode 100644
index 0000000..c4f18ad
--- /dev/null
+++ b/xyz/openbmc_project/User/Attributes.interface.yaml
@@ -0,0 +1,39 @@
+description: >
+ Provides user objects, their properties.
+ As communication to this service is done through authenticated
+ & authorized session, there won't be any validation for the both.
+
+properties:
+ - name: UserGroups
+ type: array[string]
+ description: >
+ Groups to which the user belong.
+ errors:
+ - xyz.openbmc_project.Common.Error.InternalFailure
+
+ - name: UserPrivilege
+ type: string
+ description: >
+ Privilege of the user.
+ errors:
+ - xyz.openbmc_project.Common.Error.InternalFailure
+
+ - name: UserEnabled
+ type: boolean
+ description: >
+ Enabled or disabled state of the user.
+ errors:
+ - xyz.openbmc_project.Common.Error.InternalFailure
+
+ - name: UserLockedForFailedAttempt
+ type: boolean
+ description: >
+ Locked or unlocked state of the user. After repeated failed
+ login attempt (configured through MaxLoginAttemptBeforeLockout),
+ locked out user can be unlocked manually by setting false to
+ this property. This property will return true if user is locked
+ out user. AccountUnlockTimeout property can be configured to unlock
+ the user after a timeout.
+ errors:
+ - xyz.openbmc_project.Common.Error.InternalFailure
+# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4
OpenPOWER on IntegriCloud