Files
tryton/modules/ldap_authentication/doc/index.rst
T

43 lines
953 B
ReStructuredText
Raw Normal View History

2014-09-20 13:58:31 +02:00
LDAP Authentication Module
##########################
The LDAP authentication module allows to authenticate users via a LDAP server.
2022-12-20 14:07:50 +01:00
The configuration of the LDAP connection is set in the ``ldap_authentication``
2014-09-20 13:58:31 +02:00
section.
2022-12-20 14:07:50 +01:00
To be activated, the ``ldap`` method must be added to the ``authentications``
methods list of the ``session`` section of the configuration.
2016-05-31 12:55:54 +02:00
2014-09-20 13:58:31 +02:00
Configuration
*************
uri
---
2022-10-02 00:23:53 +02:00
The LDAP URL to use to connect to the server following the :rfc:`2255`.
2022-10-10 23:55:12 +02:00
It is extended to support `SSL
<https://en.wikipedia.org/wiki/Secure_Sockets_Layer>`_ and `STARTTLS
<https://en.wikipedia.org/wiki/STARTTLS>`_.
2022-10-10 21:18:17 +02:00
The available protocols are:
- ``ldap``: simple LDAP
- ``ldap+tls``: LDAP with STARTTLS
- ``ldaps``: LDAP with SSL
2014-09-20 13:58:31 +02:00
bind_pass
---------
The LDAP password used to bind if needed.
uid
---
2022-12-20 14:07:50 +01:00
The UID Attribute for authentication (default is ``uid``).
2014-09-20 13:58:31 +02:00
create_user
-----------
A boolean to create user if not in the database.