diff docs/api/api.rst @ 2009:b63adad7c4af beta

API updates - update_user will do lookup by userid param that can be id or username - all params are required for update_user api call - get_user/s will return ldap_dn param which is more correct
author Marcin Kuzminski <marcin@python-works.com>
date Tue, 21 Feb 2012 02:35:43 +0200
parents 34d009e5147a
children 14dffcfebb02
line wrap: on
line diff
--- a/docs/api/api.rst	Tue Feb 21 01:18:00 2012 +0200
+++ b/docs/api/api.rst	Tue Feb 21 02:35:43 2012 +0200
@@ -111,7 +111,7 @@
                 "email" :    "<email>",
                 "active" :   "<bool>",
                 "admin" :    "<bool>",
-                "ldap" :     "<ldap_dn>"
+                "ldap_dn" :  "<ldap_dn>"
             }
 
     error:  null
@@ -141,7 +141,7 @@
                 "email" :    "<email>",
                 "active" :   "<bool>",
                 "admin" :    "<bool>",
-                "ldap" :     "<ldap_dn>"
+                "ldap_dn" :  "<ldap_dn>"
               },

             ]
@@ -191,14 +191,15 @@
     api_key : "<api_key>"
     method :  "update_user"
     args :    {
+                "userid" : "<user_id or username>",
                 "username" :  "<username>",
                 "password" :  "<password>",
                 "email" :     "<useremail>",
-                "firstname" : "<firstname> = None",
-                "lastname" :  "<lastname> = None",
-                "active" :    "<bool> = True",
-                "admin" :     "<bool> = False",
-                "ldap_dn" :   "<ldap_dn> = None"
+                "firstname" : "<firstname>",
+                "lastname" :  "<lastname>",
+                "active" :    "<bool>",
+                "admin" :     "<bool>",
+                "ldap_dn" :   "<ldap_dn>"
               }
 
 OUTPUT::