diff --git a/docs/api/api.rst b/docs/api/api.rst --- a/docs/api/api.rst +++ b/docs/api/api.rst @@ -216,8 +216,9 @@ get_user -------- Get's an user by username or user_id, Returns empty result if user is not found. +If userid param is skipped it is set to id of user who is calling this method. This command can be executed only using api_key belonging to user with admin -rights. +rights, or regular users which cannot specify userid parameter. INPUT:: @@ -226,7 +227,7 @@ INPUT:: api_key : "" method : "get_user" args : { - "userid" : "" + "userid" : "" } OUTPUT:: @@ -351,14 +352,14 @@ INPUT:: method : "update_user" args : { "userid" : "", - "username" : " = Optional", - "email" : " = Optional", - "password" : " = Optional", - "firstname" : " = Optional", - "lastname" : " = Optional", - "active" : " = Optional", - "admin" : " = Optional", - "ldap_dn" : " = Optional" + "username" : " = Optional(None)", + "email" : " = Optional(None)", + "password" : " = Optional(None)", + "firstname" : " = Optional(None)", + "lastname" : " = Optional(None)", + "active" : " = Optional(None)", + "admin" : " = Optional(None)", + "ldap_dn" : " = Optional(None)" } OUTPUT::