Changes between Version 43 and Version 44 of WebRpc

Timestamp:

Aug 21, 2009, 3:51:20 PM (15 years ago)

Author:

davea

Comment:

--

WebRpc

@@ -180 +180 @@
 ----
 == Create account == #create_account
- '''URL'''::
-        project_url/create_account.php
- '''input'''::
-        email_addr:
- email address. [[BR]] [[BR]]
-        passwd_hash:
- The MD5 hash of the concatenation of the user's password and the lower case form of their EMail address. The user password itself is never sent on an RPC call for privacy. [[BR]] [[BR]]
-        user_name:
- the user name.[[BR]] [[BR]]
-        [ invite_code: ]
- Invitation code if project requires invitation to create accounts.[[BR]] [[BR]]
- '''examples'''::
+'''URL'''
+project_url/create_account.php
+
+'''input'''
+
+email_addr: email address.
+
+passwd_hash: The MD5 hash of the concatenation of the user's password and the lower case form of their EMail address. The user password itself is never sent on an RPC call for privacy.
+
+user_name: the user name.
+
+[ invite_code: ] Invitation code if project requires invitation to create accounts.
+
+'''example'''::
         http://ralph.bakerlab.org/create_account.php?email_addr=feet1st@noyaspamhoo.com&passwd_hash=2ab548fae3162ccfa1a2d41a55557a92&user_name=CrunchAll
 
- '''output'''::
+'''output'''
         
 {{{
 <account_out>
     <authenticator>XXX</authenticator>
+    [ <opaque_auth>xxx</opaque_auth> ]
 </account_out>
 }}}
 
-  '''action'''::
-        If the project already has an account with that email address, and a different password, it returns an error. If an account with that email address exists and has the same password, it returns the authenticator.  Otherwise the project creates an account and returns the authenticator.
+'''action'''
+
+If the project already has an account with that email address, and a different password, it returns an error.
+If an account with that email address exists and has the same password, it returns the authenticator.
+Otherwise the project creates an account and returns the authenticator.
+
+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.
+
 ----
 == Look up account == #lookup_account
@@ -220 +231 @@
 <account_out>
     [ <authenticator>XXX</authenticator> ]
+    [ <opaque_auth>xxx</opaque_auth> ]
 </account_out>
 }}}
@@ -227 +239 @@
 The authentication string may also be obtained using the [userw:Boinccmd_tool#Account_query_and_attach boinccmd --lookup_account]  tool from an attached BOINC client; or, if the client is attached to the project and not using a weak authentication key, it is also stored in the project's account file, in the <authenticator> tag. This file is located in the BOINC data directory of the BOINC client, and called account_*.xml (where * is replaced by the project URL, with the "!http://" removed and any slashes replaced by underscores; ex: account_boinc.bakerlab.org_rosetta.xml).
 
+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.
 ----
 == Get account info == #am_get_info
@@ -235 +250 @@
         account_key:
  Authentication string for account to retrieve information about. See [#create_account create account RPC] or [#lookup_account lookup account RPC]   [[BR]] [[BR]]
+
+        opaque_auth: opaque authenticator, if present.
+
  '''examples'''::
  '''output'''::
@@ -271 +289 @@
         account_key:
  Authentication string of user account being changed. See [#create_account create account RPC] or [#lookup_account lookup account RPC]  [[BR]] [[BR]]
+
+        opaque_auth: opaque authenticator, if present.
+
         [ name: ]
      [[BR]] [[BR]]
@@ -314 +335 @@
         account_key:
  Authentication string of user account owning the host being changed. See [#create_account create account RPC] or [#lookup_account lookup account RPC]      [[BR]] [[BR]]
+
+        opaque_auth: opaque authenticator, if present.
+
         hostid:
      [[BR]] [[BR]]
@@ -339 +363 @@
         [ auth: ]
  Authentication string of user to display. See [#create_account create account RPC] or [#lookup_account lookup account RPC].  Either id: or auth: must be specified. [[BR]] [[BR]]
+
+        opaque_auth: opaque authenticator, if present.
+
         format:
  output formatting. 'xml' is only supported value (default is HTML formatting)  [[BR]] [[BR]]
@@ -407 +434 @@
         authenticator:
  Authentication string for user account to retrieve pending credit information about. See [#create_account create account RPC] or [#lookup_account lookup account RPC]   [[BR]] [[BR]]
+
+        opaque_auth: opaque authenticator, if present.
+
  '''examples'''::
         http://boinc.bakerlab.org/rosetta/pending.php?format=xml&authenticator=X
@@ -429 +459 @@
         account_key:
  Authentication string of team founder's user account. See [#create_account create account RPC] or [#lookup_account lookup account RPC]   [[BR]] [[BR]]
+
+        opaque_auth: opaque authenticator, if present.
+
         name:
  name of team.   [[BR]] [[BR]]
@@ -535 +568 @@
         [ account_key: ]
  Authentication string of a team administrator's user account. See [#create_account create account RPC] or [#lookup_account lookup account RPC]   [[BR]] [[BR]]
+
+        opaque_auth: opaque authenticator, if present.
+
         xml:
  output formatting. 0=HTML, 1=XML. (default is 0)   [[BR]] [[BR]]
@@ -574 +610 @@
         account_key:
  Authentication string of user account to change preferences for. See [#create_account create account RPC] or [#lookup_account lookup account RPC]    [[BR]] [[BR]]
+
+        opaque_auth: opaque authenticator, if present.
+
         [ avatar_url: ]
  ''Note: the image will be downloaded and stored locally. Only JPG and PNG accepted.''     [[BR]] [[BR]]