diff options
Diffstat (limited to 'xyz')
| -rw-r--r-- | xyz/openbmc_project/User/Manager.interface.yaml | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/xyz/openbmc_project/User/Manager.interface.yaml b/xyz/openbmc_project/User/Manager.interface.yaml index a4c2d7b..3874071 100644 --- a/xyz/openbmc_project/User/Manager.interface.yaml +++ b/xyz/openbmc_project/User/Manager.interface.yaml @@ -57,6 +57,47 @@ methods: - xyz.openbmc_project.User.Common.Error.UserNamePrivFail - xyz.openbmc_project.User.Common.Error.NoResource + - name: GetUserInfo + description: > + Get user properites. + If its local user, method returns + -user privilege + -user groups + -user enabled state + -user locked state + -remote user flag + If its ldap user, method returns + -user privilege + -remote user flag + parameters: + - name: UserName + type: string + description: > + User name whose properties have to be returned. + returns: + - name: UserInfo + type: dict[string,variant[string,array[string],boolean]] + description: > + Dictionary of user properties. + List of key name and data type of properties below. + UserPrivilege -> privilege of the user(string) + UserGroups -> list of groups user belongs to(array[string]) + UserEnabled -> user enabled state(boolean) + UserLockedForFailedAttempt -> user locked state(boolean) + RemoteUser -> remote or local user(boolean) + + For detailed documentation of user properties refer + Attributes.interface.yaml + examples: + 1.UserInfo["RemoteUser"] returns true for ldap user + and false for local user. + 2.UserInfo["UserGroups"] gets list of groups of user. + errors: + - xyz.openbmc_project.Common.Error.InternalFailure + - xyz.openbmc_project.Common.Error.InsufficientPermission + - xyz.openbmc_project.Common.Error.InvalidArgument + - xyz.openbmc_project.User.Common.Error.UserNameDoesNotExist + properties: - name: AllPrivileges type: array[string] |
