Table of Contents
Introduction
Description
This connector implements the LDAP standard and it is used to connect the Sync-Server with every server that allows this communication protocol.
Managed Systems
There a lot of server and products that use this standard, for example the most known systems are:
389 Directory Server
Apache Directory Server
OpenLDAP
OpenDJ
Active Directory
Oracle Directory Server
For more information: List of LDAP software
For more information to check if your system may be synchronized with this connector you do not hesitate to contact us through our Contact form
Prerequisites
It is needed a user with full administrator access.
Download and install
This addon is located in the Connectors section and its name is LDAP plugin.
For download and install the addon you could review our generic documentation about this process: Addons installation
Agent configuration
Basics
Generic parameters
After the installation of the addon, you may create and configure agent instances.
To configure this LDAP Connector you must select "LDAP-Custom (with triggers)" in the attribute "Type" of the generic parameters section in the agents page configuration.
For more information about how you may configure the generic parameters of the agent, see the following link: Agents configuration
Custom parameters
Below there are the specific parameters for this agent implementation:
| Parameter | Description |
|---|---|
| User name | User name in DN format, including base name if needed |
| Password | Password |
| Host name | Host name of the server |
Base DN | LDAP Base name |
| PasswordAttribute | |
| Password hash algorightm | |
Password hash prefix | |
LDAP Query page size | |
| Enable debug | Two options: Yes, No. When it is enabled more log traces are printed in the Synchronization Server log |
Attribute mapping
This connector can manage users, accounts, roles, groups and grants.
As a limitation, it cannot detect password changes to be propagated to other systems.
Properties
Renaming
To support object renaming, Soffid needs to store Soffid account name on a specific LDAP attribute. It's highly recommended to index such a field. To enable it, add the following properties to each object mapping:
Property | Value |
|---|---|
| rename | true |
| key | <LDAP attribute where Soffid account name is stored> |
| modificationTimestamp | LDAP attribute |
If a key value is set, LDAP connector will search for objects based on this LDAP attribute value, rather than its DN. Thus, an index on this attributed is highly recommended.
At any time, object renaming can be disabled by setting the property
Property | Value |
|---|---|
| rename | false |
Incremental load
It is possible to configure the LDAP connector as an authoritative data source. In order to speed-up the load process, it is advisable to use an incremental loading strategy. To enable it, you must uncheck the "Full reconciliation" configuration switch, and add a modificationTimestamp property. It must contain the attribute that holds the modification timestamp for each object.
Property | Value |
|---|---|
| modificationTimestamp | LDAP attribute that holds the modification timestamp, typically "modificationTimestamp" |
Once configured, the sync server will build an LDAP query to filter out objects with a modification timestamp older than the previously successfully finished load process. Mind the query will reload any change performed five minutes before the last load process, to deal with clock skew and replication problems.
Attributes
You can map user, groups and role objects. User membership must be managed on the role members attribute expression.
Any object mapping must have the following system attributes:
System attribute | Value |
|---|---|
| objectClass | LDAP Object Class. It can evaluate to an array of objects |
| dn | Full qualified object name |
For more information about how you may configure attribute mapping, see the following link: Soffid Attribute Mapping Reference
For example:
Triggers
Pending to be documented.
Load triggers
Pending to be documented.
Account metadata
Pending to be documented.
Operational
Monitoring
After the agent configuration you could check in the monitoring page if the service is running in the Synchronization Server, please go to "Start Menu > Monitoring and reporting > System monitoring".
Tasks
Authoritative
If you are checked "Authorized identity source", an automatic task to load identities from the managed system to Soffid is available, please go to "Start Menu > Processes and Tasks > Manage automatic tasks", and you will something like "Import authoritative data from <AGENT_NAME>".
Reconcile
If your are configured the "Attribute Mapping" tab with some of our objects: "user, account, role, group or grant", an automatic task to synchronize these objects from the managed system to Soffid is available, please go to "Start Menu > Processes and Tasks > Manage automatic tasks", and you will something like "Reconcile all accounts from <AGENT_NAME>".
Synchronization
About the synchronization of the objects, there are two possible options:
- If you are checked the generic attribute "Read Only" in the "Basics" tab, only the changes in the managed systems will be updated in Soffid. We recommend this options until the global configuration of Soffid will be tested.
- If you are not checked the generic attribute "Read Only" in the "Basics" tab, all the changes in Soffid or the managed system will be updated in the other. Note that this synchronization must be configured in the "Attribute mapping" tab correctly.