Skip to content

LDAP Integration

EEforce integrates with Active Directory (AD) and other LDAP-compatible directories for user authentication and group synchronization. This allows your team to log in with their existing corporate credentials.

Overview

LDAP integration provides:

  • Authentication - Users log in with their AD username and password
  • Auto-provisioning - New user accounts are created automatically on first login
  • Group synchronization - EEforce groups can be linked to AD groups for automatic membership updates
  • SSL support - Secure LDAP (LDAPS) connections

How It Works

User enters AD credentials in EEforce Client
    -> EEforce Server binds to AD using the service account
    -> Server validates user credentials against AD
    -> If auto-register is enabled and user is new, account is created
    -> Group memberships are synchronized
    -> User is logged in

INFO

LDAP users are marked with a flag in the system. Their passwords are never stored locally - authentication always goes through the directory.


Configuration

From the Web Admin Interface

Navigate to Admin -> Settings -> LDAP Settings tab.

LDAP Configuration

From the Desktop Client

Open Admin -> LDAP Configuration from the menu bar.

LDAP Configuration


Settings Reference

SettingDescriptionExample
DomainThe LDAP/AD domain to authenticate againstcorp.example.com
Service AccountUsername of the account used to query the directorysvc_eeforce
Service Account PasswordPassword for the service account(stored encrypted)
Use Secure Socket Layer (SSL)Connect via LDAPS (port 636) instead of plain LDAP (port 389)Enabled/Disabled
Auto-register LDAP users on first loginAutomatically create an EEforce account when an unknown LDAP user logs in successfullyEnabled/Disabled

Service Account Requirements

The service account needs read access to user and group objects in Active Directory. It does not need write permissions. Use a dedicated service account with minimal privileges.


Setup Steps

1. Create a Service Account in AD

Create a service account in Active Directory with read permissions:

  • No special admin rights needed
  • Set password to never expire (or manage rotation)
  • Example: [email protected]

2. Configure LDAP in EEforce

  1. Open the web admin: http://<server>/Admin
  2. Go to Settings -> LDAP Settings
  3. Fill in:
    • Domain: Your AD domain (e.g., corp.example.com)
    • Service Account: The service account username
    • Service Account Password: The service account password
  4. Enable Use Secure Socket Layer if your domain controller supports LDAPS
  5. Enable Auto-register LDAP users on first login (recommended)
  6. Click Save LDAP Settings

3. Test the Connection

Use the built-in test panel (available in web admin) to verify the configuration:

Test ModeWhat It Checks
Service Account ConnectionValidates that the service account can bind to the directory
User LookupFinds a specific user in AD and retrieves their display name
Group LookupResolves a group identifier (DN, sAMAccountName, or CN)
List User GroupsShows all AD groups a specific user belongs to
User LoginPerforms a full authentication test with a user's credentials

TIP

Always test with Service Account Connection first. If that fails, check the domain name, service account credentials, and network connectivity to the domain controller.

4. Enable Auto-Registration (Optional)

When enabled, any user who successfully authenticates against AD will automatically get an EEforce account created. This eliminates the need to manually create accounts for each team member.

If disabled, an administrator must manually create accounts and mark them as LDAP-authenticated before users can log in.


Group Synchronization

EEforce groups can be linked to AD groups. When linked, group membership is automatically synchronized based on AD membership.

How Group Sync Works

  1. An administrator links an EEforce group to an AD group by setting the LDAP Group Identifier.
  2. When an LDAP user logs in, the system checks their AD group memberships.
  3. For each linked EEforce group:
    • If the user is in the corresponding AD group -> they are added to the EEforce group
    • If the user is NOT in the AD group -> they are removed from the EEforce group
  4. Changes are applied immediately on login.

Linking a Group

From the Web Admin:

  1. Go to Groups management page
  2. Select or create a group
  3. Set the LDAP Group Identifier field to one of:
    • Distinguished Name: CN=Engineering,OU=Groups,DC=corp,DC=local
    • sAMAccountName: Engineering
    • Common Name: Engineering

From the Desktop Client:

  1. Open Admin -> Group Management
  2. Select a group
  3. Set the LDAP Group Identifier field

INFO

The LDAP Group Identifier is matched flexibly - you can use the full Distinguished Name (DN), the sAMAccountName, or the CN. The system will try to resolve it.

Sync-on-Login vs. Manual Sync

MethodWhen It RunsScope
On LoginEvery time an LDAP user logs inThat user's memberships across all linked groups
Manual Group SyncAdministrator triggers from web adminAll LDAP users in a specific group

Example Configuration

EEforce GroupLDAP Group IdentifierEffect
Hardware TeamCN=HW-Engineers,OU=Teams,DC=corp,DC=localAll AD members of HW-Engineers are added to Hardware Team
Project AdministratorsEEforce-AdminsAD members of EEforce-Admins get Manager access to all projects
Project CreatorsEEforce-CreatorsAD members can create new projects

User Lifecycle

New LDAP User (Auto-Register Enabled)

  1. User opens EEforce Client and enters AD credentials
  2. Server authenticates against AD -> success
  3. Server creates an EEforce account with:
    • User ID = AD username (sAMAccountName)
    • Display Name = AD display name
    • Marked as LDAP-authenticated
  4. Group sync runs -> user is added to appropriate linked groups
  5. User is logged in

Existing LDAP User

  1. User enters credentials
  2. Server authenticates against AD
  3. Group sync runs (memberships updated if changed)
  4. User is logged in

User Leaves the Organization

When an AD account is disabled or deleted:

  • The user cannot authenticate anymore (login fails)
  • Their EEforce account remains but is inaccessible
  • An administrator can manually delete or deactivate the account

TIP

Consider periodically reviewing user accounts in the web admin to clean up accounts for departed employees.


SSL/LDAPS

For secure connections:

  1. Ensure your domain controller has a valid SSL certificate (port 636)
  2. Enable Use Secure Socket Layer in EEforce LDAP settings
  3. If using a self-signed CA, install the CA certificate on the EEforce server machine

WARNING

Plain LDAP (port 389) transmits credentials in clear text on the network. Always use LDAPS in production environments.


Troubleshooting

IssuePossible CauseResolution
Service account test failsWrong credentials or domainVerify domain, username, and password. Try domain\username format.
User lookup returns nothingUser not in expected OUThe search covers the entire domain tree; check the username spelling
Group sync not updatingLDAP Group Identifier not setVerify the group has a valid identifier in group management
SSL connection failsCertificate not trustedInstall the AD CA certificate on the server machine
Auto-register not workingSetting is disabledEnable Auto-register LDAP users on first login in settings
Login slowDNS resolution issuesEnsure the server can resolve the AD domain name quickly