Changes between Version 58 and Version 59 of WebRpc

Timestamp:

Jun 20, 2016, 6:13:05 AM (8 years ago)

Author:

Christian Beer

Comment:

update lookup_account RPC to current implementation

WebRpc

@@ -226 +226 @@
 == Look up account == #lookup_account
  '''action'''::
-        If passwd_hash is given and is correct,
-        the user's authentication string is returned.
-        This authentication string is required for many of the other RPCs.
-        If no account with the EMail address provided exists,
-        an error is returned.
-
-  If <opaque_auth> is included in the reply,
-  all subsequent RPCs that reference the account must supply the given string
-  as well as the authenticator.
+        If passwd_hash is given and is correct, the user's authentication string is returned. This authentication string is required for many of the other RPCs.
+        If no paswd_hash is given and the account exists, a success message is returned.
+        If no account with the EMail address provided exists, an error is returned.
+
+        If ldap_auth is non-zero and ldap_uid and passwd are given, authenticate using the LDAP_HOST specified in project.inc. If no account with the EMail address of the ldap_uid exists, a new one is created and the authenticator returned.
+
  '''URL'''::
         project_url/lookup_account.php
  '''input'''::
 
- email_addr:: email address
+ [ email_addr ]:: email address of account (ignored when ldap_auth is non-zero)
  [ passwd_hash ]::
   The MD5 hash of the concatenation of the user's password
   and the lower case form of the account's EMail address.
- [ get_opaque_auth ]::
-  Return the opaque authenticator for the user if the project provides one.
+ [ ldap_auth ]::
+  Needs to be non-zero in order to use LDAP authentication. When enabled, ''ldap_uid'' and ''passwd'' must be supplied too.
+ [ ldap_uid ]::
+  The LDAP userid that can be found on LDAP_HOST (defined in project.inc)
+ [ passwd ]::
+  The password authenticating the LDAP userid.
 
  '''examples'''::
@@ -253 +254 @@
 <account_out>
     [ <authenticator>XXX</authenticator> ]
-    [ <opaque_auth>xxx</opaque_auth> ]
+    [ <success/> ]
 </account_out>
 }}}