ldapsaisie/doc/conf
Benjamin Renard 0ec390e1fe Add API feature
Some major changes have been made to handle this new feature :
- LSsession now have a flag about API mode. The displayTemplate() and
  displayAjaxReturn() methods have been adjust to correctly handle this
  mode.
- LSauth system have been adjust to handle a custom API mode :
  - LSauthMethod can support or not this mode : the $api_mode_supported
    permit to defined if supported (default, false). Currently, only
    HTTP (default in API mode) and annonymous mode support it.
  - An api_access parameter permit to configure witch type of user
    LSobject types could use the API. This flag must be set to True to
    allow a type of LSobject (default: False). In a same way, a
    web_access parameter now permit to disable Web access for some
    types of users (but this parameter is optional and its default value
    is True).
  - The HTTP method is the privileged first method for API mode. In this
    mode, if auth data aren't present in environment, it will request it
    by triggered a 403 HTTP error. Realm can be configured with new
    LSAUTHMETHOD_HTTP_API_REALM constant.
- The LStemplate system handle API mode to correctly react on errors: it
  return a JSON answer instead of HTML page. Error pages also now return
  adjusted HTTP code (404 or 500).
- The LSurl system have been adjust to handle API mode :
  - On declaring handlers, we could now specify if it's an API view with
    new $api_mode paremeter of add_handler() method
  - The LSurlRequest object have a new attribute to check if it's an API
    request
  - The error_404() method handle the API mode to return JSON answer.
    Furthermore, if no handlers matched with the requested URL, API mode
    is automatically enabled if the requested URL starts with 'api/'.
- LSform implement it own API mode flag and a new submited flag that
  be toggle via the new setSubmited() method. Some major changes also
  occured on LSformElement classes to specifically handle API
  input/output for each types of attributes:
  - a new getApiValue() method permit to retrieve the API value of the
    attribute (on show API view)
  - the getPostData() method now have to correctly handle API input for
    the attribute (on create/modify API views). A programmatic way have
    been adopted for each types of attributes.
- The LSimport and LScli create/modify commands also evolved to enable
  API mode of the LSform. This permit to take advantage of the new
  capability of LSform/LSformElement to handle input values with a
  programmatic way.
- New routes have been add to handle API views. All this new routes
  start with 'api/1.0/' and use the same URL schema as the web UI. The
  API currently permit to search/show/add/modify/remove LSobjects and
  manages their relations.
2021-02-03 14:40:28 +01:00
..
LSaddon Add LSaddon::showTechInfo 2020-09-21 15:47:07 +02:00
LSattribute LSattribute: add default LDAP & HTML type (ascii / text) 2021-01-29 15:59:13 +01:00
LSauthMethod Add API feature 2021-02-03 14:40:28 +01:00
LSobject Doc: fix typo 2020-05-19 18:13:02 +02:00
conf.docbook Doc / LSauth : Updated relative to last commit 2010-11-25 11:21:43 +01:00
conf.entities.xml Improve logging 2019-06-28 18:00:37 +02:00
globale.docbook LSsession: fix/improve methods & doc about global preference parameters 2020-08-06 13:48:43 +02:00
LDAP_search_params.docbook - Documentation : commit initial. 2009-03-17 19:21:10 +00:00
LSaddon.docbook Add LSaddon::showTechInfo 2020-09-21 15:47:07 +02:00
LSattribute.docbook LSattribute: add default LDAP & HTML type (ascii / text) 2021-01-29 15:59:13 +01:00
LSauthMethod.docbook Doc / LSauthMethod_anonymous : Added informations about this LSauthMethod 2010-11-25 12:49:03 +01:00
LSformat.docbook Fix and improve LSformat PHP and JS implementations 2018-09-20 19:28:26 +02:00
LSlog.docbook LSlog: add TRACE log level 2020-08-07 18:05:50 +02:00
LSobject.docbook doc: fix info about LSobject and LSattribute event triggers configuration 2020-08-26 17:06:24 +02:00
LSprofile.docbook Add default LSprofiles with the name of authenticable object types 2020-05-25 11:09:32 +02:00
recoverPassword.docbook Doc : fix <citetitle> HTML element style 2017-06-15 18:47:28 +02:00
srv-ldap.docbook Add API feature 2021-02-03 14:40:28 +01:00
subDn.docbook Doc : fix <citetitle> HTML element style 2017-06-15 18:47:28 +02:00