Mercurial > public > src > rhodecode
diff docs/api/api.rst @ 2467:b902baeaa494 beta
API, added delete_user method.
- create_user now also returns new user object data as get_user
- updated docs
author | Marcin Kuzminski <marcin@python-works.com> |
---|---|
date | Thu, 31 May 2012 18:42:49 +0200 |
parents | 347b00545b60 |
children | 04ef27ce939e |
line wrap: on
line diff
--- a/docs/api/api.rst Wed May 30 21:12:04 2012 +0200 +++ b/docs/api/api.rst Thu May 31 18:42:49 2012 +0200 @@ -187,7 +187,18 @@ result: { "id" : "<new_user_id>", - "msg" : "created new user <username>" + "msg" : "created new user <username>", + "user": { + "id" : "<id>", + "username" : "<username>", + "firstname": "<firstname>", + "lastname" : "<lastname>", + "email" : "<email>", + "active" : "<bool>", + "admin" : "<bool>", + "ldap_dn" : "<ldap_dn>", + "last_login": "<last_login>", + }, } error: null @@ -195,7 +206,7 @@ update_user ----------- -updates current one if such user exists. This command can +updates given user if such user exists. This command can be executed only using api_key belonging to user with admin rights. @@ -220,7 +231,33 @@ result: { "id" : "<edited_user_id>", - "msg" : "updated user <username>" + "msg" : "updated user ID:<userid> <username>" + } + error: null + + +delete_user +----------- + + +deletes givenuser if such user exists. This command can +be executed only using api_key belonging to user with admin rights. + + +INPUT:: + + id : <id_for_response> + api_key : "<api_key>" + method : "delete_user" + args : { + "userid" : "<user_id or username>", + } + +OUTPUT:: + + result: { + "id" : "<edited_user_id>", + "msg" : "deleted user ID:<userid> <username>" } error: null