LDAP Management
Platform administrators can add, update, and delete LDAP services on the platform.
TOC
LDAP Overview
LDAP (Lightweight Directory Access Protocol) is a mature, flexible, and well-supported standard mechanism for interacting with directory servers. It organizes data in a hierarchical tree structure to store enterprise user and organization information, primarily used for implementing single sign-on (SSO).
LDAP Key Features:
- Enables communication between clients and LDAP servers
- Supports data storage, retrieval, and search operations
- Provides client authentication capabilities
- Facilitates integration with other systems
For more information, refer to the LDAP official documentation.
Supported LDAP Types
OpenLDAP
OpenLDAP is an open-source implementation of LDAP. If your organization uses open-source LDAP for user authentication, you can configure the platform to communicate with the LDAP service by adding LDAP and configuring relevant parameters.
OpenLDAP Integration:
- Enables platform authentication for LDAP users
- Supports standard LDAP protocols
- Provides flexible user management
For more information about OpenLDAP, refer to the OpenLDAP official documentation.
Active Directory
Active Directory is Microsoft's LDAP-based software for providing directory storage services in Windows systems. If your organization uses Microsoft Active Directory for user management, you can configure the platform to communicate with the Active Directory service.
Active Directory Integration:
- Enables platform authentication for AD users
- Supports Windows domain integration
- Provides enterprise-level user management
LDAP Terminology
OpenLDAP Common Terms
Active Directory Common Terms
Add LDAP
After successful LDAP integration:
- Users can log in to the platform using their enterprise accounts
- Multiple additions of the same LDAP will overwrite previously synchronized users
Prerequisites
Before adding LDAP, prepare the following information:
- LDAP server address
- Administrator username
- Administrator password
- Other required configuration details
Steps
- In the left navigation bar, click Users > IDPs
- Click Add LDAP
- Configure the following parameters:
Basic Information
Search Settings
Search Settings Purpose:
- Matches LDAP user entries based on specified conditions
- Extracts key user and group attributes
- Maps LDAP attributes to platform user attributes
-
In the IDP Service Configuration Validation section:
- Enter a valid LDAP account username and password
- The username must match the Login Field setting
- Click to verify the configuration
-
(Optional) Configure LDAP Auto-Sync Policy:
- Enable Auto-Sync Users switch
- Set synchronization rules
- Use online tool to verify CRON expressions
-
Click Add
After adding LDAP:
- Users can log in before synchronization
- User information syncs automatically on first login
- Auto-sync occurs based on configured rules
LDAP Configuration Examples
LDAP Connector Configuration
The following example shows how to configure an LDAP connector:
User Filter Examples
Group Search Configuration Examples
Examples of AND(&) and OR(|) Operators in LDAP Filters
Synchronize LDAP Users
After successfully synchronizing LDAP users to the platform, you can view the synchronized users in the user list.
You can configure an automatic synchronization policy when adding LDAP (which can be updated later) or manually trigger synchronization after adding LDAP successfully. Here's how to manually trigger a synchronization operation.
Notes:
-
Newly added users in the LDAP integrated with the platform can log in to the platform before performing the user synchronization operation. Once they successfully log in to the platform, their information will be automatically synchronized to the platform.
-
Users deleted from LDAP will have an
Invalidstatus after synchronization. -
The default validity period for newly synchronized users is Permanent.
-
Synchronized users with the same name as existing users (local users, IDP users) are automatically associated. Their permissions and validity period will be consistent with existing users. They can log in to the platform using the login method corresponding to their respective sources.
Procedure of Operation
-
In the left navigation bar, click Users > IDPs.
-
Click the LDAP name that you want to manually synchronize.
-
Click Actions > Sync user in the upper-right corner.
-
Click Sync.
Notes: If you manually close the synchronization prompt dialog, a confirmation dialog will appear to confirm the closure. After closing the synchronization prompt dialog, the system will continue to synchronize users. If you remain on the user list page, you will receive synchronization result feedback. If you leave the user list page, you will not receive synchronization results.
Relevant Operations
You can click the
on the right in the list page or click Actions in the upper-right corner on the details page to update or delete LDAP as needed.