.. /*  
    * This file is part of the SavaPage project <https://www.savapage.org>.
    * Copyright (c) 2026 Datraverse B.V.
    * Author: Rijk Ravestein.
    *
    * SPDX-FileCopyrightText: (c) 2020 Datraverse B.V. <info@datraverse.com>
    * SPDX-License-Identifier: CC-BY-SA-4.0
    *
    * For more information, please contact Datraverse B.V. at this
    * address: info@datraverse.com
    */

.. _app-advanced-ldap-config:

.. figure:: ../images/manual/savapage-logo-no-text-100px.png
   :width: 75px

Advanced LDAP Configuration
===========================

.. admonition:: |ADMONITION_TABLE_OF_CONTENTS|

   - :numref:`{number}. {name} <app-advanced-ldap-config-props>`
   - :numref:`{number}. {name} <app-advanced-ldap-config-default>`

.. _app-advanced-ldap-config-props:

LDAP Configuration Properties
-----------------------------

SavaPage supports several LDAP server types out-of-the-box.
The basic configuration options for these types are discussed at
:ref:`LDAP <ch-webapp-admin-options-user-source-ldap>`.

However, other server/schema types can be supported by defining the fields
to query and the LDAP searches to perform. These options are configured
by adjusting entries in the |RST_LINK_CONFIG_EDITOR| of the Admin
Web App. The following configuration properties are available:

.. list-table:: LDAP Configuration Properties
   :width: 100%
   :header-rows: 1
   
   * - Configuration property
     - Description
     
   * - ldap.schema.user-name-field
   
     - | The LDAP field that contains the user's username.
       |
       | Content of this field is converted to lowercase when
       | synchronized with the SavaPage database.
           
   * - ldap.schema.user-full-name-field
   
     - | The LDAP field that contains the user's full name.

   * - ldap.schema.user-email-field
   
     - | The LDAP field that contains the user's email address.
       |
       | Content of this field is converted to lowercase when
       | synchronized with the SavaPage database.
           
   * - ldap.schema.user-department-field
   
     - | The LDAP field that contains the user's department.
     
   * - ldap.schema.user-office-field
   
     - | The LDAP field that contains the user's office location. 

   * - ldap.schema.user-name-search
   
     - | The LDAP search to retrieve the  user. The ``{0}`` in the search  
       | is replaced with ``*`` when listing all users, and ``[username]`` 
       | when searching for a specific user.
       |
       | If no search is defined, the default is ``(userNameField={0})``, 
       | where ``userNameField`` is the value  of configuration property
       | "ldap.schema.user-name-field".
       |
       | IMPORTANT: The search must include the ``{0}`` 
       | value and involve the LDAP field as specified in 
       | configuration property "ldap.schema.user-name-field".

   * - ldap.schema.group-name-field
   
     - | The LDAP field that contains the group's name.

   * - ldap.schema.group-full-name-field
   
     - | The LDAP field that contains the  group's full name.
     
   * - ldap.schema.group-member-field
   
     - | The LDAP field that contains the group members.
     
   * - ldap.schema.group-search
   
     - | The LDAP search to retrieve the  group. The ``{0}`` in the 
       | search is replaced with ``*`` for all group searches.
       |
       | If no search is defined, the  default is ``([groupMemberField]={0})``, 
       | which means get all entries with at least one member. 
       |
       | IMPORTANT: The search must include the ``{0}`` value.
     
   * - ldap.schema.posix-groups
   
     - | If ``Y``, then the group member field contains the user's
       | username. If ``N``, then the group member field contains the 
       | user's DN.