Skip to main content

LDAP Synchronization configuration

Environment properties

LDAP connection properties

  • All those properties can start as ldap instead of security.ldap. If both of them are defined, the security.ldap property is used, not the ldap property.
  • If security.ldap.import.base property is defined, security.ldap.base property is not used.
  • If security.ldap.configurationProperty property is defined, security searches for properties with prefix defined in this property instead of prefix ldap.
PropertyTypeRequired for LDAP synchronizationDescriptionExample value
security.ldap.urlstringtrueLDAP server URLldap://server:port
security.ldap.basestringtrueLDAP context basedc=company,dc=local
security.ldap.userDnstringtrueLDAP service account dnCN=ldap,OU=Accounts,OU=Common,DC=company,DC=local
security.ldap.passwordstringtrueLDAP service account passwordthis-is-secret
security.ldap.referralstringfalse
security.ldap.ignorePartialResultExceptionbooleanfalse (default false)Ignore partial result exception while searchtrue

LDAP import properties

PropertyTypeRequired for LDAP synchronizationDescriptionExample valueSince version
security.ldap.import.enabledbooleantrue (default false)Is LDAP import enabledtrue
security.ldap.import.cronExpressionstringfalseAutomatic LDAP import schedule (cron) expressions0 0/30 * * * ?
security.ldap.import.basestringfalseOverwrites general ldap.base property for importdc=company,dc=local
security.ldap.import.paging.enabledbooleanfalseEnables paging of ldap import.true8.25.8
security.ldap.import.paging.sizeintegerfalse (true if paging enabled)Import page size.10008.25.8
security.ldap.configurationPropertystringfalse (default ldap)Overwrites ldap connection properties prefixldap

LDAP property configuration example

security.ldap.base=dc=company,dc=local
security.ldap.userDn=CN=ldap,OU=Accounts,OU=Common,DC=company,DC=local
security.ldap.url=ldap://server:port
security.ldap.ignorePartialResultException=true
security.ldap.password=this-is-secret
security.ldap.import.enabled=true
security.ldap.import.cronExpression=0 0/30 * * * ?

Database configuration

sec_config table

  • All those properties are optional string properties stored in sec_config table in database used for ldap mappings. If property is not set in database, default value is used instead.
  • Example value for principal: ${sAMAccountName}@company.local
PropertyDefault value
ldapImport.statusBitMask000000000010
ldapImport.externalId${userPrincipalName!}
ldapImport.username${sAMAccountName!}
ldapImport.principal${userPrincipalName!}
ldapImport.firstName${givenName!}
ldapImport.lastName${sn!}
ldapImport.email${mail!}
ldapImport.street${streetAddress!}
ldapImport.streetNumber
ldapImport.city${l!}
ldapImport.zip${postalCode!}
ldapImport.statusAttribute${userAccountControl}

Console configuration

  • In security server administration console, two data object can be managed - import sources and groups mappings.

Import sources

  • Import source is where filters for LDAP import are managed.
  • Stored in db table sec_ldap_import.
PropertyTypeDescriptionExample value
NameStringName of LDAP import sourceLDAP source
LDAP BaseStringLDAP context basedc=company,dc=local
LDAP FilterStringLDAP filter(memberOf=CN=ML Group,OU=Groups,OU=Common,DC=company,DC=local)
User typePick value (sec_user_type)Imported user typeLDAP

Groups mapping

  • You can manage mapping of LDAP groups to LIDS groups here.
  • Stored in db table sec_ldap_groups.
PropertyTypeDescriptionExample value
NameStringName of LDAP groups mappingclients-read
LDAP BaseStringLDAP context basedc=company,dc=local
LDAP Group DN/CNStringLDAP Group domain/canonical nameCN=Group,OU=Groups,OU=Common,DC=company,DC=local
Security groupPick value (sec_group)SAMO GroupSAMO Users