LDAP-Rest

Lite LinID directory manager is a lightweight directory manager that provides LDAP integration through a plugin-based architecture. This system enables directory management operations with configurable authentication, extensible functionality through events/hooks, and extensible REST API.

Core plugins also provide plugins that ensure LDAP data consistency.

Key Features

• Robust Error Handling - Server stays online even when plugins encounter errors
• Plugin Architecture - Extensible through a powerful plugin system
• Flexible Authentication - Support for multiple authentication methods
• REST API - Complete LDAP operations through REST endpoints
• Event Hooks - Intercept and customize LDAP operations
• Browser Libraries - Ready-to-use JavaScript components

How it works

All configuration is done via command-line arguments and/or environment variables. Example:

npx ldap-rest --ldap-base 'dc=example,dc=com' \
    --ldap-dn 'cn=admin,dc=example,dc=com' --ldap-pwd admin \
    --ldap-url ldap://localhost \
    --log-level notice \
    --plugin core/ldap/groups --ldap-group-base 'ou=groups,dc=example,dc=com' \
    --plugin core/ldap/externalUsersInGroups

LDAP Failover

Multiple LDAP servers are supported for high availability:

--ldap-url ldap://ldap1.example.com,ldap://ldap2.example.com,ldap://ldap3.example.com

The system automatically tries each URL in order and fails over if a connection fails.

Log Levels

LDAP-Rest uses syslog-style log levels:

• error - Only errors
• warn - Warnings and errors
• notice - Web access logs (recommended for production)
• info - General info + web logs
• debug - All debug output

Use --log-level notice for production to see web access logs without general info messages.

Configuration

See Configuration Guide for all CLI options and environment variables.

Documentation

Documentation is organized into 3 categories:

Usage

Installation, configuration and plugin usage.

• Getting Started - Quick start guide
• Configuration - CLI options and environment variables
• Plugins - Plugin documentation
• Authentication - Token, TOTP, HMAC, LemonLDAP::NG, OpenID Connect

Plugin Development

Create and extend LDAP-Rest with custom plugins.

• Development Guide - Architecture and plugin creation
• Hooks - LDAP hooks system
• Contributing - Contribution guide

Client Application Development

Integrate LDAP-Rest into your web applications.

• REST API - Complete API reference
• Browser Libraries - Web components
• Examples - React, Vue.js, Vanilla JS
• Browser Demos - Interactive demos (TOTP client, LDAP tree viewer)

Copyright and license

Copyright 2025-present LINAGORA

Licensed under GNU AGPL-3.0