Added and implemented user/change_pw, user/update and user/change_email, removed...

[hermes] / api-nodes.txt

diff --git a/api-nodes.txt b/api-nodes.txt
index b01058a9f5946e489845e0820e465e329bd685ab..9dc240a113608bfbc1e54ca4cdb50b248649b05b 100644 (file)
--- a/api-nodes.txt
+++ b/api-nodes.txt
@@ -60,10 +60,22 @@ user/change_pw?user=foo@bar.bz&password=baz
 
 user/update?username=foo&domain=bar
 user/update?user=foo@bar.bz
-  optionals: &displayname=baz&dialplan=(.*)&linetext=lalala
+  optionals: &displayname=baz&dialplan=(.*)&linetext=lalala&email=foo@bar.baz
        Not implemented! Will only be implemented for Local users.
        Remote users will have to be removed, and re-added.
 
+user/change_email?username=foo&domain=bar&email=user@example.com
+user/change_email?user=foo@bar.bz&email=user@example.com
+       Changes the email address for the given user, returns 'ok' with
+       'user' set to the requested username and 'email' set to the
+       email address.  This only applies to kamailio local users.
+
+       Returns 'failed' with 'cause' = 'nonexistant' if user does not exist.
+       
+       Returns 'failed' with 'cause' = 'dbfail' if the database request
+       failed. Note that this may be because the given password was identical
+       to the old.
+
 
 user/remove?username=foo&domain=bar
 user/remove?user=foo@bar.bz