Skip to content

Active Directory Authentication

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

Configuration keyDescriptionDefault value
cfg.authentication.baseurl
Available in4.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
Available in3.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
Available in3.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
Available in4.1.0 +
Activate the Email Notification parameter for the adopted user.TRUE
cfg.authentication.external.adoption-rule.basedn
Available in4.1.0 +
The base DN (search base) for the search in the directory that will be performed by this rule.
cfg.authentication.external.adoption-rule.createGroup
Available in4.1.0 +
Determines whether groups retrieved from the repository should be created in S-Filer.
cfg.authentication.external.adoption-rule.excludeFilter
Available in4.1.0 +
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
Available in4.1.0 +
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
Available in4.1.0 +
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
Available in4.1.0 +
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
Available in4.1.0 +
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
Available in4.1.0 +
Determine the search level.1
cfg.authentication.external.adoption-rule.sfilerGroup
Available in4.1.0 +
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
Available in3.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').sAMAccountName
cfg.authentication.external.adoption.cn
Available in3.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
Available in3.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').displayName
cfg.authentication.external.adoption.mail
Available in3.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
Available in3.0.1 +
LDAP attribute name indicating a group member (e.g., 'member').member
cfg.authentication.external.adoption.objectclass.group
Available in4.2.1 +
The object class to use when looking for groups in the LDAP directory (e.g., 'group', 'groupOfNames', 'groupOfUniqueNames').group
cfg.authentication.external.adoption.objectclass.user
Available in4.2.1 +
The object class to use when looking for users in the LDAP directory (e.g., 'person', 'inetOrgPerson').person
cfg.authentication.external.autoenroll
Available in4.2.292 +
If auto enrollment is true, the authentication for an unknown user account will be attempted and if it succeeds, the user account will be created in S-Filer. If it is set to false the authentication for an unknown user account won't be attempted, this will avoid locking AD/LDAP accounts that are not defined in the adoption policy.false
cfg.authentication.external.default.enrollment.role
Available in4.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.external.kerberos.kdc
Available in3.0.2 +
This is the IP address or hostname of the KDC (Key Distribution Center), e.g., mainkdc.example.com)
cfg.authentication.external.kerberos.realm
Available in3.0.2 +
This is the Kerberos Domain name (Windows Domain) in uppercase, e.g., EXAMPLE.COM
cfg.authentication.external.kerberos.sso
Available in4.0.6 +
Select « Yes » to allow users to authenticate via SSO.false
cfg.authentication.external.kerberos.sso.keytab
Available in4.0.6 +
This is the path to the keytab file (on Windows, generated using the ktpass utility).
cfg.authentication.external.kerberos.sso.princ
Available in4.0.6 +
The name of the principal to use in the keytab file, e.g., HTTP/hostname.domain.com@DOMAIN.COM)
cfg.authentication.ldap.connection.pool.size.initial
Available in2.1.0 +
Maximum number of simultaneous connections to the LDAP directory.10
cfg.authentication.ldap.connection.timeout
Available in2.1.0 +
Number of milliseconds after which the S-Filer server will stop waiting for a connection to the LDAP server.30000
cfg.authentication.ldap.primary.admin.password
Available in2.1.0 +
Administrator authentication password.password
cfg.authentication.ldap.primary.admin.user
Available in2.1.0 +
Administrative user ID used to access the LDAP Directory.demoadministrator
cfg.authentication.ldap.primary.follow.ldap.referral
Available in3.0.1 +
Tell the system if it must follow the LDAP Referraltrue
cfg.authentication.ldap.primary.host
Available in2.1.0 +
Host name or IP address of the LDAP Directory.127.0.0.1
cfg.authentication.ldap.primary.port
Available in2.1.0 +
Port used to access the LDAP Directory.389
cfg.authentication.ldap.primary.ssl
Available in3.0.1 +
Whether SSL should be used to access LDAP.false
cfg.authentication.ldap.provider
Available in2.1.0 +
Java class used as an LDAP Provider.com.sun.jndi.ldap.LdapCtxFactory
cfg.authentication.ldap.read.timeout
Available in4.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
Available in2.1.0 +
Base DN of the S-Filer System in the LDAP Directory.CN=Users,DC=demo,DC=local
cfg.authentication.username.case.sensitive
Available in4.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'.)False