comparison 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
comparison
equal deleted inserted replaced
2008:9ddbfaeefb73 2009:b63adad7c4af
109 "firstname": "<firstname>", 109 "firstname": "<firstname>",
110 "lastname" : "<lastname>", 110 "lastname" : "<lastname>",
111 "email" : "<email>", 111 "email" : "<email>",
112 "active" : "<bool>", 112 "active" : "<bool>",
113 "admin" :  "<bool>", 113 "admin" :  "<bool>",
114 "ldap" : "<ldap_dn>" 114 "ldap_dn" : "<ldap_dn>"
115 } 115 }
116 116
117 error: null 117 error: null
118 118
119 119
139 "firstname": "<firstname>", 139 "firstname": "<firstname>",
140 "lastname" : "<lastname>", 140 "lastname" : "<lastname>",
141 "email" : "<email>", 141 "email" : "<email>",
142 "active" : "<bool>", 142 "active" : "<bool>",
143 "admin" :  "<bool>", 143 "admin" :  "<bool>",
144 "ldap" : "<ldap_dn>" 144 "ldap_dn" : "<ldap_dn>"
145 }, 145 },
146 146
147 ] 147 ]
148 error: null 148 error: null
149 149
189 INPUT:: 189 INPUT::
190 190
191 api_key : "<api_key>" 191 api_key : "<api_key>"
192 method : "update_user" 192 method : "update_user"
193 args : { 193 args : {
194 "userid" : "<user_id or username>",
194 "username" : "<username>", 195 "username" : "<username>",
195 "password" : "<password>", 196 "password" : "<password>",
196 "email" : "<useremail>", 197 "email" : "<useremail>",
197 "firstname" : "<firstname> = None", 198 "firstname" : "<firstname>",
198 "lastname" : "<lastname> = None", 199 "lastname" : "<lastname>",
199 "active" : "<bool> = True", 200 "active" : "<bool>",
200 "admin" : "<bool> = False", 201 "admin" : "<bool>",
201 "ldap_dn" : "<ldap_dn> = None" 202 "ldap_dn" : "<ldap_dn>"
202 } 203 }
203 204
204 OUTPUT:: 205 OUTPUT::
205 206
206 result: { 207 result: {