diff docs/api/api.rst @ 2090:bdc0ad168006 beta

API added explicit method for updating user account
author Marcin Kuzminski <marcin@python-works.com>
date Sun, 19 Feb 2012 20:00:18 +0200
parents 0f87c784756e
children 7dfcdf4c7dd2
line wrap: on
line diff
--- a/docs/api/api.rst	Sun Feb 19 19:36:42 2012 +0200
+++ b/docs/api/api.rst	Sun Feb 19 20:00:18 2012 +0200
@@ -151,7 +151,7 @@
 create_user
 -----------
 
-Creates new user or updates current one if such user exists. This command can 
+Creates new user. This command can 
 be executed only using api_key belonging to user with admin rights.
 
 
@@ -179,6 +179,37 @@
     error:  null
 
 
+update_user
+-----------
+
+updates current one if such user exists. This command can 
+be executed only using api_key belonging to user with admin rights.
+
+
+INPUT::
+
+    api_key : "<api_key>"
+    method :  "update_user"
+    args :    {
+                "username" :  "<username>",
+                "password" :  "<password>",
+                "email" :     "<useremail>",
+                "firstname" : "<firstname> = None",
+                "lastname" :  "<lastname> = None",
+                "active" :    "<bool> = True",
+                "admin" :     "<bool> = False",
+                "ldap_dn" :   "<ldap_dn> = None"
+              }
+
+OUTPUT::
+
+    result: {
+              "id" : "<edited_user_id>",
+              "msg" : "updated user <username>"
+            }
+    error:  null
+
+
 get_users_group
 ---------------