Configuring directory sync with Active Directory or other LDAP servers

An LDAP directory is a collection of data about users and groups. LDAP (Lightweight Directory Access Protocol) is an Internet protocol that web applications can use to look up information about those users and groups from the LDAP server.

We provide built-in connectors for the most popular LDAP directory servers, such as:

  • Microsoft Active Directory
  • Apache Directory Server (ApacheDS)
  • Apple Open Directory
  • Fedora Directory Server
  • Novell eDirectory
  • OpenDS
  • OpenLDAP
  • Sun Directory Server Enterprise Edition (DSEE)
  • A generic LDAP directory server

Requirements#

Connecting to the LDAP Server#

  1. Run the Directory Connector application.
  2. Go to the Settings tab.
  3. Select Active Directory / LDAP as the Type of directory server you are configuring.

The following directory configuration options can be set:

PropertyDescriptionExamples
Server HostnameThe hostname of your directory server.ad.example.com or ldap.company.local
PortThe port on which your directory server is listening.389 or 10389
Root PathThe root path at which the Directory Connector should start all queries.cn=users,dc=ad,dc=company,dc=com
SSLIf the server is using LDAP over SSL (LDAPS).
TLSIf the server is using LDAP over TLS (STARTTLS).
Active DirectoryIf the server is an Active Directory server.
UsernameThe distinguished name of an administrative user that the application will use when connecting to the directory server. For Active Directory, the user should be a member of the built-in administrators group.cn=admin,cn=users,dc=ad,dc=company,dc=com or company\admin (Active Directory)
PasswordThe password of the user specified above. The password is safely stored in the operating system's native credential manager.

:::table %}

Configuring Sync Settings#

  1. Launch the Directory Connector desktop application
  2. Go to the Settings tab.
  3. Configure the appropriate Sync settings for your Active Directory or LDAP server.
note

If you are using Active Directory, many of these settings are predetermined for you and are therefore are not shown.

PropertyDescriptionExamples
IntervalThe interval, in minutes, that you wish to perform automatic sync checks.5
Remove Disabled UsersWhen a user is disabled in the directory, should they also be removed from your SecretSafe organization?
Overwrite Existing UsersAlways perform a full sync and remove any users from your organization if they are not in the synced users set.
Member AttributeThe attribute field to use when loading the group's members.uniqueMember
Creation Date AttributeThe attribute field that specifies when an entry was created.whenCreated
Revision Date AttributeThe attribute field that specifies when an entry was changed.whenChanged
Use Email Prefix/SuffixEmail addresses are required by SecretSafe. If your directory users do not have email addresses they will be skipped. Alternatively, you can specify that users without an email address use a prefix attribute concatenated with a suffix to attempt to form a valid email address.
Email Prefix AttributeThe attribute field to use when forming a user's email address from the prefix/suffix setting.accountName
Email SuffixThe specified suffix to use when forming a user's email address from the prefix/suffix setting.@example.com
Sync UsersSync users to your organization.
User FilterA filter for limiting the users that are synced. Read more at Configuring user and group sync filters.(&(givenName=John))
User Object ClassThe name of the class used for the LDAP user object.user
User PathThis value is used in addition to the root path when searching and loading users. If no value is supplied, the subtree search will start from the root path.ou=Users
User Email AttributeThe attribute field to use when loading the user email address.mail
Sync GroupsSync groups to your organization.
Group FilterA filter for limiting the groups that are synced. Read more at Configuring user and group sync filters.(&!(name=Sales*))
Group Object ClassThe name of the class used for the LDAP group object.groupOfUniqueNames
Group PathThis value is used in addition to the root path when searching and loading groups. If no value is supplied, the subtree search will start from the root path.ou=Groups
Group Name AttributeThe attribute field to use when loading the group name.name

:::table %}