Evergreen DokuWiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
[[user-comments:open-ils_auth_api:open-ils.auth|User Comments]]

===== open-ils.auth.authenticate.complete =====

Client provides the username and passwordhash (see
open-ils.auth.authenticate.init).  If their password hash is
correct for the given username, a session id is returned,
if not, "0" is returned


  * [[osrf-devel:terms#opensrf_api-level|API Level]]: 1
  * [[osrf-devel:terms#opensrf_server_class|Server Class]]: open-ils.auth
  * Implementation Method: [[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Open-ILS/src/perlmods//OpenILS/Application/Auth.pm|OpenILS::Application::Auth::comp
lete_authenticate]]
  * Streaming [[osrf-devel:terms#opensrf_method|Method]]: No
  * Cachable [[osrf-devel:terms#opensrf_method|Method]]: No

  * **Parameters:**
    * //param1//\\ what it is...
  * **Returns:**
    * //Success//\\ successful format
    * //Failure//\\ failure format (exception, etc)
===== open-ils.auth.authenticate.init =====

Generates a random seed and returns it.  The client
must then perform md5_hex( $seed . md5_hex($password) ) and use that
as the passwordhash to open-ils.auth.authenticate.complete


  * [[osrf-devel:terms#opensrf_api-level|API Level]]: 1
  * [[osrf-devel:terms#opensrf_server_class|Server Class]]: open-ils.auth
  * Implementation Method: [[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Open-ILS/src/perlmods//OpenILS/Application/Auth.pm|OpenILS::Application::Auth::init
_authenticate]]
  * Streaming [[osrf-devel:terms#opensrf_method|Method]]: No
  * Cachable [[osrf-devel:terms#opensrf_method|Method]]: No

  * **Parameters:**
    * //param1//\\ what it is...
  * **Returns:**
    * //Success//\\ successful format
    * //Failure//\\ failure format (exception, etc)


===== open-ils.auth.session.delete =====

Pass in a sessionid and this delete it from the cache


  * [[osrf-devel:terms#opensrf_api-level|API Level]]: 1
  * [[osrf-devel:terms#opensrf_server_class|Server Class]]: open-ils.auth
  * Implementation Method: [[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Open-ILS/src/perlmods//OpenILS/Application/Auth.pm|OpenILS::Application::Auth::dele
te_session]]
  * Streaming [[osrf-devel:terms#opensrf_method|Method]]: No
  * Cachable [[osrf-devel:terms#opensrf_method|Method]]: No

  * **Parameters:**
    * //param1//\\ what it is...
  * **Returns:**
    * //Success//\\ successful format
    * //Failure//\\ failure format (exception, etc)


===== open-ils.auth.session.retrieve =====

Pass in a sessionid and this returns the username associated with it


  * [[osrf-devel:terms#opensrf_api-level|API Level]]: 1
  * [[osrf-devel:terms#opensrf_server_class|Server Class]]: open-ils.auth
  * Implementation Method: [[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Open-ILS/src/perlmods//OpenILS/Application/Auth.pm|OpenILS::Application::Auth::retr
ieve_session]]
  * Streaming [[osrf-devel:terms#opensrf_method|Method]]: No
  * Cachable [[osrf-devel:terms#opensrf_method|Method]]: No

  * **Parameters:**
    * //param1//\\ what it is...
  * **Returns:**
    * //Success//\\ successful format
    * //Failure//\\ failure format (exception, etc)


===== opensrf.open-ils.system.fieldmapper =====

what I do

  * [[osrf-devel:terms#opensrf_api-level|API Level]]: 1
  * [[osrf-devel:terms#opensrf_server_class|Server Class]]: open-ils.auth
  * Implementation Method: [[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Open-ILS/src/perlmods/OpenILS/Utils/Fieldmapper.pm|Fieldmapper::publish_fieldmapper]]
  * Streaming [[osrf-devel:terms#opensrf_method|Method]]: No
  * Cachable [[osrf-devel:terms#opensrf_method|Method]]: No

  * **Parameters:**
    * //param1//\\ what it is...
  * **Returns:**
    * //Success//\\ successful format
    * //Failure//\\ failure format (exception, etc)