Changes between Version 43 and Version 44 of WebRpc


Ignore:
Timestamp:
Aug 21, 2009, 3:51:20 PM (13 years ago)
Author:
davea
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WebRpc

    v43 v44  
    180180----
    181181== Create account == #create_account
    182  '''URL'''::
    183         project_url/create_account.php
    184  '''input'''::
    185         email_addr:
    186  email address. [[BR]] [[BR]]
    187         passwd_hash:
    188  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]]
    189         user_name:
    190  the user name.[[BR]] [[BR]]
    191         [ invite_code: ]
    192  Invitation code if project requires invitation to create accounts.[[BR]] [[BR]]
    193  '''examples'''::
     182'''URL'''
     183project_url/create_account.php
     184
     185'''input'''
     186
     187email_addr: email address.
     188
     189passwd_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.
     190
     191user_name: the user name.
     192
     193[ invite_code: ] Invitation code if project requires invitation to create accounts.
     194
     195'''example'''::
    194196        http://ralph.bakerlab.org/create_account.php?email_addr=feet1st@noyaspamhoo.com&passwd_hash=2ab548fae3162ccfa1a2d41a55557a92&user_name=CrunchAll
    195197
    196  '''output'''::
     198'''output'''
    197199       
    198200{{{
    199201<account_out>
    200202    <authenticator>XXX</authenticator>
     203    [ <opaque_auth>xxx</opaque_auth> ]
    201204</account_out>
    202205}}}
    203206
    204   '''action'''::
    205         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.
     207'''action'''
     208
     209If the project already has an account with that email address, and a different password, it returns an error.
     210If an account with that email address exists and has the same password, it returns the authenticator.
     211Otherwise the project creates an account and returns the authenticator.
     212
     213If <opaque_auth> is included in the reply,
     214all subsequent RPCs that reference the account must supply the given string
     215as well as the authenticator.
     216
    206217----
    207218== Look up account == #lookup_account
     
    220231<account_out>
    221232    [ <authenticator>XXX</authenticator> ]
     233    [ <opaque_auth>xxx</opaque_auth> ]
    222234</account_out>
    223235}}}
     
    227239The 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).
    228240
     241If <opaque_auth> is included in the reply,
     242all subsequent RPCs that reference the account must supply the given string
     243as well as the authenticator.
    229244----
    230245== Get account info == #am_get_info
     
    235250        account_key:
    236251 Authentication string for account to retrieve information about. See [#create_account create account RPC] or [#lookup_account lookup account RPC]   [[BR]] [[BR]]
     252
     253        opaque_auth: opaque authenticator, if present.
     254
    237255 '''examples'''::
    238256 '''output'''::
     
    271289        account_key:
    272290 Authentication string of user account being changed. See [#create_account create account RPC] or [#lookup_account lookup account RPC]  [[BR]] [[BR]]
     291
     292        opaque_auth: opaque authenticator, if present.
     293
    273294        [ name: ]
    274295     [[BR]] [[BR]]
     
    314335        account_key:
    315336 Authentication string of user account owning the host being changed. See [#create_account create account RPC] or [#lookup_account lookup account RPC]      [[BR]] [[BR]]
     337
     338        opaque_auth: opaque authenticator, if present.
     339
    316340        hostid:
    317341     [[BR]] [[BR]]
     
    339363        [ auth: ]
    340364 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]]
     365
     366        opaque_auth: opaque authenticator, if present.
     367
    341368        format:
    342369 output formatting. 'xml' is only supported value (default is HTML formatting)  [[BR]] [[BR]]
     
    407434        authenticator:
    408435 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]]
     436
     437        opaque_auth: opaque authenticator, if present.
     438
    409439 '''examples'''::
    410440        http://boinc.bakerlab.org/rosetta/pending.php?format=xml&authenticator=X
     
    429459        account_key:
    430460 Authentication string of team founder's user account. See [#create_account create account RPC] or [#lookup_account lookup account RPC]   [[BR]] [[BR]]
     461
     462        opaque_auth: opaque authenticator, if present.
     463
    431464        name:
    432465 name of team.   [[BR]] [[BR]]
     
    535568        [ account_key: ]
    536569 Authentication string of a team administrator's user account. See [#create_account create account RPC] or [#lookup_account lookup account RPC]   [[BR]] [[BR]]
     570
     571        opaque_auth: opaque authenticator, if present.
     572
    537573        xml:
    538574 output formatting. 0=HTML, 1=XML. (default is 0)   [[BR]] [[BR]]
     
    574610        account_key:
    575611 Authentication string of user account to change preferences for. See [#create_account create account RPC] or [#lookup_account lookup account RPC]    [[BR]] [[BR]]
     612
     613        opaque_auth: opaque authenticator, if present.
     614
    576615        [ avatar_url: ]
    577616 ''Note: the image will be downloaded and stored locally. Only JPG and PNG accepted.''     [[BR]] [[BR]]