Skip to content

LDAP Directory authentication instance

This manual lists all the configurations that the S-Filer Portal's Configuration CLI can change about the LDAP Directory authentication instance.

Configuration keyDescriptionDefault value
cfg.authentication.baseurl (Since 4.1.1)The Base URL used in mail notifications for users in this domain. As an example, this allows setting a different URL for employees and partners, assuming they are in different domains and there are multiple web interfaces configured.https://localhost/sfiler/
cfg.authentication.external.active (Since 3.0.0)Select « Yes » to enable this authentication mechanism. Remember to turn on the multi-domain feature in the Web GUI configuration to be able to use it in the web interface.false
cfg.authentication.external.adoption (Since 3.0.0)If this value is positive, the adoption will be done for this mechanism. The system will then adopt the user from the external user registry into the S-Filer system. Adoption occurs whenever the adoption task runs. This task can be scheduled in the scheduler section of the server configuration.false
cfg.authentication.external.adoption-rule.activateMailNotification (Since 4.2.1)Activate the Email Notification parameter for the adopted user.TRUE
cfg.authentication.external.adoption-rule.basedn (Since 4.2.1)The base DN (search base) for the search in the directory that will be performed by this rule.
cfg.authentication.external.adoption-rule.createGroup (Since 4.2.1)Determines whether groups retrieved from the repository should be created in S-Filer.
cfg.authentication.external.adoption-rule.excludeFilter (Since 4.2.1)Exclusion Filter parameter (LDAP based search filter). This makes it possible to exclude specific entries of the adoption process. Ex: (mail=*@example.com)
cfg.authentication.external.adoption-rule.excludeGroupFilter (Since 4.2.1)This parameter makes it possible to avoid the creation of some specific groups. This option will be used only if "Create group" is set to Yes. Follow with a semi-colon-separated list of groups you wish to exclude from the adoption.
cfg.authentication.external.adoption-rule.includeFilter (Since 4.2.1)Inclusion Filter parameter (LDAP based search filter). This makes it possible to limit the number of entries of the adoption process. Ex: (mail=*@example.com)
cfg.authentication.external.adoption-rule.includeGroupeMember (Since 4.2.1)Determines whether members of a group will be adopted (if not already adopted) and become member of the corresponding group in S-Filer.TRUE
cfg.authentication.external.adoption-rule.includeGroupFilter (Since 4.2.1)This parameter makes it possible to limit the group creation to certain entries only. This option will be used only if "Create group" is set to Yes. Follow with a semi-colon-separated list of groups you wish to adopt.
cfg.authentication.external.adoption-rule.searchDepth (Since 4.2.1)Determine the search level.1
cfg.authentication.external.adoption-rule.sfilerGroup (Since 4.2.1)Enter the list of S-Filer groups that should be granted automatically to users once adopted. Enter the group names exactly as they appear in S-Filer separated by ';'.
cfg.authentication.external.adoption.account (Since 3.0.0)This is the attribute that contains the username to use in the login page. Specify an attribute in the LDAP directory (e.g., 'cn', 'sAMAccountName', 'uid').cn
cfg.authentication.external.adoption.cn (Since 3.0.0)This is the attribute that identifies the LDAP entry, commonly called the RDN (e.g., 'cn').cn
cfg.authentication.external.adoption.display.name (Since 3.0.0)This is the attribute that contains the display name of the user (e.g., 'Jean Martin'). Specify an attribute in the LDAP directory (e.g., 'sn', 'displayName').sn
cfg.authentication.external.adoption.mail (Since 3.0.0)This is the attribute that contains the email address of the user. Specify an attribute in the LDAP directory (e.g., 'email').mail
cfg.authentication.external.adoption.member (Since 3.0.1)LDAP attribute name indicating a group member (e.g., 'member').member
cfg.authentication.external.adoption.objectclass.group (Since 4.2.1)The object class to use when looking for groups in the LDAP directory (e.g., 'group', 'groupOfNames', 'groupOfUniqueNames').groupOfNames
cfg.authentication.external.adoption.objectclass.user (Since 4.2.1)The object class to use when looking for users in the LDAP directory (e.g., 'person', 'inetOrgPerson').person
cfg.authentication.external.default.enrollment.role (Since 4.16.0)This is the default role assigned to a user who is created in this domain (by adoption or auto enrollment).0
cfg.authentication.force.mfa (Since 4.19.0)Select « Yes » to force all users in this domain to use multi-factor authentication (MFA). A user trying to login will be forced to configure its MFA if he has not already done so.false
cfg.authentication.ldap.connection.pool.size.initial (Since 2.1.0)Maximum number of simultaneous connections to the LDAP directory.20
cfg.authentication.ldap.connection.timeout (Since 2.1.0)Number of milliseconds after which the S-Filer server will stop waiting for a connection to the LDAP server.10000
cfg.authentication.ldap.primary.admin.password (Since 2.1.0)Administrator authentication password.secret
cfg.authentication.ldap.primary.admin.user (Since 2.1.0)Administrative user ID used to access the LDAP Directory.uid=admin,ou=system
cfg.authentication.ldap.primary.follow.ldap.referral (Since 3.0.1)Tell the system if it must follow the LDAP Referraltrue
cfg.authentication.ldap.primary.host (Since 2.1.0)Host name or IP address of the LDAP Directory.127.0.0.1
cfg.authentication.ldap.primary.port (Since 2.1.0)Port used to access the LDAP Directory.389
cfg.authentication.ldap.primary.ssl (Since 3.0.1)Whether SSL should be used to access LDAP.false
cfg.authentication.ldap.provider (Since 2.1.0)Java class used as an LDAP Provider.com.sun.jndi.ldap.LdapCtxFactory
cfg.authentication.ldap.read.timeout (Since 4.16.0)Number of milliseconds after which the S-Filer server will stop waiting for a response from the LDAP server.900000
cfg.authentication.ldap.root.name (Since 2.1.0)Base DN of the S-Filer System in the LDAP Directory.ou=sfiler,dc=okiok,dc=com
cfg.authentication.username.case.sensitive (Since 4.0.7)Whether accounts in this authentication domain are case sensitive or not. (Example: In Windows, accounts are NOT case sensitive. User 'test' is equivalent to user 'TEST'.)True