docs/RELEASE_NOTES_NEXT/API/auth-login-api.adoc

   1 New open-ils.auth.login API
   2 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
   3 The open-ils.auth service has a new API for requesting an authentication
   4 token.  It performs the same steps as the
   5 open-ils.auth.authenticate.init and .complete APIs in a single call,
   6 using the bare password.  No intermediate password hashing is required.
   7
   8 The paramters are the same as the .complete call with a few modifications.
   9
  10 1. Using the generic "identifier" parameter in combination with the
  11    "org" parameter allows the API to reliably determine if an identifier
  12    value is a username or barcode.  The caller is no longer required to
  13    make that determination up front.
  14
  15 2. The 'nonce' parameter is no longer used.
  16
  17 Upgrade Notes
  18 +++++++++++++
  19
  20 The new open-ils.auth.login API must be added to the list of <log_protect>
  21 API's in the opensrf_core.xml file.
  22
  23 Sample diff:
  24
  25 [code,sh]
  26 ---------------------------------------------------------------------
  27 --- a/Open-ILS/examples/opensrf_core.xml.example
  28 +++ b/Open-ILS/examples/opensrf_core.xml.example
  29 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
  30      <log_protect>
  31        <match_string>open-ils.auth.authenticate.verify</match_string>
  32        <match_string>open-ils.auth.authenticate.complete</match_string>
  33 +      <match_string>open-ils.auth.login</match_string>
  34        <match_string>open-ils.auth_proxy.login</match_string>
  35        <match_string>open-ils.actor.patron.password_reset.commit</match_string>
  36        <match_string>open-ils.actor.user.password</match_string>
  37 ---------------------------------------------------------------------
  38