Chat now with support
Chat with Support

Identity Manager 8.0 - Administration Guide for Connecting to LDAP

Managing LDAP Environments Setting up LDAP Directory Synchronization Basic Configuration Data LDAP Domains LDAP User Accounts LDAP Groups LDAP Container Structures LDAP Computers Reports about LDAP Objects Appendix: Configuration Parameters for Managing LDAP Appendix: Default Project Template for LDAP Appendix: Authentication Modules for Logging into the One Identity Manager

Users and Permissions for Synchronizing with LDAP

Users and Permissions for Synchronizing with LDAP

The following users are involved in synchronizing One Identity Manager with LDAP.

Table 2: Users for Synchronization
User Permissions
User for accessing the LDAP directory A reasonable minimal configuration for the synchronization user account cannot be recommended because the permissions depend which on the LDAP directory service is implemented. For more information about which permissions are required, see your LDAP directory service documentation.
One Identity Manager Service user account

The user account for the One Identity Manager Service requires access rights to carry out operations at file level (issuing user rights, adding directories and files to be edited).

The user account must belong to the group "Domain Users".

The user account must have the extended access right "Log on as a service".

The user account requires access rights to the internal web service.

NOTE: If the One Identity Manager Service runs under the network service (NT Authority\NetworkService), you can issue access rights for the internal web service with the following command line call:

netsh http add urlacl url=http://<IP address>:<port number>/ user="NT AUTHORITY\NETWORKSERVICE"

The user account needs full access to the One Identity Manager Service installation directory in order to automatically update the One Identity Manager.

In the default installation the One Identity Manager is installed under:

  • %ProgramFiles(x86)%\One Identity (on 32-bit operating systems)
  • %ProgramFiles%\One Identity (on 64-bit operating systems)
User for accessing the One Identity Manager database

The default system user "SynchronizationClosed" is available to run synchronization over an application server.

Special Cases for synchronizing Active Directory Lightweight Directory Services

Special Cases for synchronizing Active Directory Lightweight Directory Services

There are various special cases to take into account when setting up a synchronization project for Active Directory Lightweight Directory Services (AD LDS).

AD LDS supports different authentication methods. For more detailed information about AD LDS, see the Microsoft TechNet Library.

Different settings arise, which need to be considered when setting up the synchronization project, depending on the authentication method you choose.

Authentication with AD LDS Security Principal

For this authentication method, you use a user account that is in AD LDS.

  • The user account must be a member in the group "Administrators" of the AD LDS instance.
  • The user account must have a password.

    If it does not have a password, authentication is anonymous. This causes the schema to load incorrectly and the synchronization project set up fails.

Take note of the following for setting up your synchronization project.

  • Authentication must use SSL encryption.
  • "Basic" must be used as authentication method.
  • Enter the distinguished LDAP name (DN) with the user account's user name for logging in to AD LDS.

    Syntax example: CN=Administrator,OU=Users,DC=Doku,DC=Testlab,DC=dd

Authentication with Windows Security Principal

Use a user account for authentication which resides on a local computer or in a Active Directory domain.

  • The user account must be a member in the group "Administrators" of the AD LDS instance.

Take note of the following for setting up your synchronization project.

  • "Negotiate" must be used as authentication method.
  • If SSL encoding is not being used, sealing and signing authentication modes must be enabled.
  • If SSL encoding is being used, sealing and signing authentication modes should not be enabled.
  • Enter the user principal name with the user account's user name for logging in to AD LDS.

    Syntax example: Administrator@Doku.Testlab.dd

Authentication with AD LDS Proxy Object

Use a user account for authentication which exists in AD LDS and serves as binding for a local user account or a user account in a Active Directory domain. The local user account or the Active Directory user account is referenced in AD LDS as security ID (SID).

  • The user account (AD LDS proxy object) must be a member in the group "Administrators" of the AD LDS instance.

Take note of the following for setting up your synchronization project.

  • Authentication must use SSL encryption.
  • "Basic" must be used as authentication method.
  • Use the AD LDS proxy object user name for the AD LDS login.
  • Enter the distinguished LDAP name (DN) with the user name.

    Syntax example: CN=Administrator,OU=Users,DC=Doku,DC=Testlab,DC=dd

  • The user account password referenced by the AD LDS proxy object is to be used as login password.

Setting Up the Synchronization Server

To setup synchronization with an LDAP environment a server has to be available that has the following software installed on it:

  • Windows operating system

    Following versions are supported:

    • Windows Server 2008 (non-Itanium based 64-bit) Service Pack 2 or later
    • Windows Server 2008 R2 (non-Itanium based 64-bit) Service Pack 1 or later
    • Windows Server 2012
    • Windows Server 2012 R2
    • Windows Server 2016
  • Microsoft .NET Framework Version 4.5.2 or later

    NOTE: Microsoft .NET Framework version 4.6 is not supported.

    NOTE: Take the target system manufacturer's recommendations into account.
  • Windows Installer
  • One Identity Manager Service, LDAP connector
    • Install One Identity Manager components with the installation wizard.
      1. Select the option Select installation modules with existing database.
      2. Select the machine role Server | Job Server | LDAP directories.

All One Identity Manager Service actions are executed against the target system environment on the synchronization server. Entries which are necessary for synchronization and administration with the One Identity Manager database are processed by the synchronization server. The synchronization server must be declared as a Job serverClosed in One Identity Manager.

NOTE: If several target system environments of the same type are synchronized under the same synchronization server, it is useful to set up a job server for each target system on performance grounds. This avoids unnecessary swapping of connection to target systems because a job server only has to process tasks of the same type (re-use of existing connections).

Use the Server Installer to install the One Identity Manager Service. This program executes the following steps.

  • Setting up a Job server.
  • Specifying machine roles and server function for the Job server.
  • Remote installation of One Identity Manager Service components corresponding to the machine roles.
  • Configures the One Identity Manager Service.
  • Starts the One Identity Manager Service.

NOTE: The program executes remote installation of the One Identity Manager Service. Local installation of the service is not possible with this program. Remote installation is only supported within a domain or a trusted domain.

To install and configure the One Identity Manager Service remotely on a server

  1. Start the program Server Installer on your administrative workstation.
  2. Enter valid data for connecting to One Identity Manager on the Database connection page and click Next.
  3. Specify on which server you want to install the One Identity Manager Service on the Server properties page.
    1. Select a job server in the Server menu.

      - OR -

      Click Add to add a new job server.

    2. Enter the following data for the Job server.
      Table 3: Job Servers Properties
      Property Description
      Server Name of the Job servers.
      Queue

      Name of queue to handle the process steps. Each One Identity Manager Service within the network must have a unique queue identifier. The process steps are requested by the job queue using exactly this queue name. The queue identifier is entered in the One Identity Manager Service configuration file.

      Full server name

      Full name of the server in DNS syntax.

      Example:

      <name of server>.<fully qualified domain name>

      NOTE: Use the Advanced option to edit other Job server properties. You can use the Designer to change properties at a later date.
  4. Specify which job server roles to include in One Identity Manager on the Machine role page. Installation packages to be installed on the Job server are found depending on the selected machine role.

    Select at least the following roles:

    • LDAP directories
  5. Specify the server's functions in One Identity Manager on the Server functions page. One Identity Manager processes are handled depending on the server function.

    The server's functions depend on which machine roles you have selected. You can limit the server's functionality further here.

    Select the following server functions:

    • LDAP connector
      Windows PowerShell
  6. Check the One Identity Manager Service configuration on the Service settings page.

    NOTE: The initial service configuration is already predefined. If further changes need to be made to the configuration, you can do this later with the Designer. For more detailed information about configuring the service, see One Identity Manager Configuration Guide.
  7. To configure remote installations, click Next.
  8. Confirm the security prompt with Yes.
  9. Select the directory with the install files on the Select installation source page.
  10. Select the file with the private key on the page Select private key file.

    NOTE: This page is only displayed when the database is encrypted.
  11. Enter the service's installation data on the Service access page.
    Table 4: Installation Data
    Data Description
    Computer Server on which to install and start the service from.

    To select a server

    • Enter the server name.

      - OR -

    • Select a entry from the list.
    Service account One Identity Manager Service user account data.

    To enter a user account for the One Identity Manager Service

    • Set the option Local system account.

      This starts the One Identity Manager Service under the account "NT AUTHORITY\SYSTEM".

      - OR -

    • Enter user account, password and password confirmation.
    Installation account Data for the administrative user account to install the service.

    To enter an administrative user account for installation

      Enable Advanced
    • .
    • Enable the option Current user.

      This uses the user account of the current user.

      - OR -

    • Enter user account, password and password confirmation.
  12. Click Next to start installing the service.

    Installation of the service occurs automatically and may take some time.

  13. Click Finish on the last page of the Server Installer.

    NOTE: The is entered with the name "One Identity Manager Service" in the server's service administration.

Creating a Synchronization Project for initial Synchronization of an LDAP Domain

Creating a Synchronization Project for initial Synchronization of an LDAP Domain

Use the Synchronization EditorClosed to configure synchronization between the One Identity Manager database and LDAP. The following describes the steps for initial configuration of a synchronization project.

After the initial configuration, you can customize and configure workflows within the synchronization project. Use the workflow wizard in the SynchronizationClosed Editor for this. The Synchronization Editor also provides different configuration options for a synchronization project.

Have the following information available for setting up a synchronization project.

Table 5: Information Required for Setting up a Synchronization Project
Data Explanation

LDAP server's DNS name

Full name of the LDAP server for connecting to the synchronization server to provide access to LDAP objects.

Example:

Server.Doku.Testlab.dd

Authentication type

You can only connect to a target system if the correct type of authentication is selected. Authentication type "Basic" is taken as default.

For more information about authentication types, see the MSDN Library.

Communications port on the domain controller

LDAP default communications port is 389.

User account and password for domain login

User account and password for domain login. This user account is used to access the domain. Make a user account available with sufficient permissions. For more information, see Users and Permissions for Synchronizing with LDAP.

Synchronization serverClosed for LDAP

All One Identity Manager Service actions are executed against the target system environment on the synchronization server. Entries which are necessary for synchronization and administration with the One Identity Manager database are processed by the synchronization server.

The One Identity Manager Service with the LDAP connector must be installed on the synchronization server.

The synchronization server must be declared as a Job server in One Identity Manager. Use the following properties when you set up the Job server.

Table 6: Additional Properties for the Job Server
Property Value
Server Function LDAP connector
Machine role Server/Job Server/LDAP directories

For more information, see Setting Up the Synchronization Server.

One Identity Manager Database ConnectionClosed Data

SQL Server:

  • Database server
  • Database
  • Database user and password
  • Specifies whether Windows authentication is used.

    This type of authentication is not recommended. If you decide to use it anyway, ensure that your environment supports Windows authentication.

Oracle:

  • Species whether access is direct or through the Oracle client

    Which connection data is required, depends on how this option is set.

  • Database server
  • Oracle instance port
  • Service name
  • Oracle database user and password
  • Data source (TNS alias name from TNSNames.ora)
Remote connection serverClosed

To configure synchronization with a target system, One Identity Manager must load the data from the target system. One Identity Manager communicates directly with target system to do this. If you do not have direct access on the workstation on which the Synchronization Editor is installed, because of the firewall configuration, for example, you can set up a remote connection.

The remote connection server and the workstation must be in the same Active Directory domain.

Remote connection server configuration:

  • One Identity Manager Service is started
  • RemoteConnectPlugin is installed
  • LDAP connector is installed

The remote connection server must be declared as a Job server in One Identity Manager. The Job server name is required.

TIP: The remote connection server requires the same configuration (with respect to the installed software) as the synchronization server. Use the synchronization as remote connection server at the same time, by simply installing the RemoteConnectPlugin as well.

For more detailed information about setting up a remote connection, see the One Identity Manager Target System Synchronization Reference Guide.

NOTE: The following sequence describes how you configure a synchronization project if the Synchronization Editor is both:
  • In default mode
  • Started from the launchpad

Additional settings can be made if the project wizard is run in expert mode or is started directly from the Synchronization Editor. Follow the project wizard instructions through these steps.

To set up initial synchronization project for an LDAP domain.

  1. Start the Launchpad and log on to the One Identity Manager database.

    NOTE: If synchronization is executed by an application server, connect the database through the application server.
  2. Select the entry LDAP target system type. Click Run.

    This starts the Synchronization Editor's project wizard.

  1. Specify how the One Identity Manager can access the target system on the System access page.
    • If you have access from the workstation from which you started the Synchronization Editor, do not set anything.
    • If you do not have access from the workstation from which you started the Synchronization Editor, you can set up a remote connection.

      In this case, set the option Connect using remote connection server and select, under Job server, the server you want to use for the connection.

  1. Specify settings for the wizard using the option Expert mode (Configure advanced settings) on the wizard's start page.
    • If you use a default project template, disable this option. The default templates automatically find which settings to use.
    • Set the option for custom modified LDAP environments. You can set the following options for this case:
      • Definition of virtual classes for RFC non-compliant object mappings
      • Definition of auxiliary classes of type "Auxiliary"
      • Definition of system attributes for object identification, revision attributes and additional functional attributes
      • Definition of other attributes for supping dynamic groups
  2. Enter network settings for connecting to the LDAP server on the Network page.
    • Enter the connection to the LDAP server under Host.
      Table 7: LDAP Server Connection Data
      Property Description

      Server

      Full name of the LDAP server for connecting to the synchronization server to provide access to LDAP objects.

      Example:

      Server.Doku.Testlab.dd

      Port

      Communications port on the Server. LDAP default communications port is 389.

    • Click Test connection. The system tries to connect to the server.
    • Enter additional LDAP server communication settings under Additional settings.
      Table 8: Additional Connection Settings
      Property Description

      Protocol version

      Version of the LDAP protocol.

      SSL encryption

      Specifies whether the connection is encrypted.

  3. Enter authentication data on the Authentication page.
    • Select the authentication type for logging into the system under Authentication.
    • Other information may be required depending on the selected authentication method. Enter this information under Credentials.

      Table 9: Credentials
      Property Description
      User name Name of the user account for logging on to LDAP.
      Password User account password.
      Enable sealing Specifies whether sealing is enabled. Set this option if the selected authentication method supports sealing.
      Enable signing Specifies whether signing is enabled. Set this option if the selected authentication method supports signing.
    • You can verify the connection data under LDAP verify connection. Click Test. The system tries to log on to the server.
  4. Information about the LDAP schema are displayed on the LDAP server information page.
  5. Defined additional virtual classes on the Virtual classes page.

    NOTE: This step is only displayed if you have set the option Expert mode for the system connection wizard.

    Object containing several structural classes ca only be created in LDAP systems which are not RFC compliant. They consist of one or more different classes, which are not derived from each other, for example, "OrganisationalUnit" and "inetOrgPerson".

    To map these objects

    • Enter the virtual class name in Configured virtual classes.
    • Select structural classes for mapping the virtual classes in Select structural classes.
  6. Specify search parameters for finding LDAP objects to be loaded, on the Search options page.
    Table 10: Search Options
    Property Description
    Base DN Base entry (normally the domain) for synchronization.
    Cache LDAP schema locally

    Specifies whether LDAP schema is kept in cache. This accelerates synchronization and provisioning of LDAP objects.

    The cache is on the connected computer under %Appdata%\...\Local\One Identity\One Identity Manager\Cache\GenericLdapConnector\<ConnectionInternalKey>\<Hash>\<Hash>.Cache

    Use paged search

    Specifies whether LDAP objects are listed a page at a time. If you set this option, you include the page size.

    Page size Maximum number of objects per page.
  7. Enter which type of write operations are support by the LDAP server on the Modification capabilities page.
    • Set the option Server supports renaming of entries if the LDAP server supports renaming of objects.
    • Set the option Server supports moving of entries if the LDAP server supports moving of objects.

      Note: Some servers only support object renaming at leaf level. In this case, renaming other nodes fails with an error message.

  8. Assign additional auxiliary classes to structural classes on the Assign auxiliary classes page.

    NOTE: This step is only displayed if you have set the option Expert mode for the system connection wizard.

    Auxiliary classes are classes of type "Auxiliary" and contain attributes for extending structural classes. Auxiliary class attributes are offered as optional attributes for structural classes in the schema.

    NOTE: You may have to customize the One Identity Manager schema in order to map auxiliary class attributes in One Identity Manager. Use the program SchemaClosed Extension to do this.

  9. On the System attributes page, you specify which LDAP system attribute is used to uniquely identify the objects.

    NOTE: This step is only displayed if you have set the option Expert mode for the system connection wizard.

    • Select the attribute to uniquely identify the objects in the LDAP under Object identification attributes. The attribute must be unique and set for all objects LDAP.
    • Specify which attribute to use for revision filtering under RevisionClosed properties.
    • Specify which additional attributes to determine for LDAP objects on the Additional operational attributes page. Functional attributes are used for managing directories. Attributes are only determined if they are explicitly given.

      NOTE: You may have to customize the One Identity Manager schema in order to map functional attributes in One Identity Manager. Use the program Schema Extension to do this.

  10. If the LDAP server supports dynamic groups, mark the attribute which contains the URL with the search information for matching members of dynamic groups, on the Select dynamic group attributes page, for example memberURL.

    NOTE: This step is only displayed if you have set the option Configure advanced settings (Expert mode) for the system connection wizard.

  11. Specify additional password settings for user accounts on the Password settings page.
    • Enter the following settings.
      Table 11: Password settings
      Property Description
      Password attribute Attribute representing a user account's password, for example userPassword.
      Password change method

      Method used to modify passwords,

      Value Description
      Default Default method for modifying passwords. The password is written directly to the password attribute.
      ADLDS Password modification method used for systems based on Microsoft Active Directory Lightweight Directory Services (AD LDS).
  1. Verify the One Identity Manager database connection data on the One Identity Manager connection page. The data is loaded from the connected database. Reenter the password.

    NOTE: Reenter all the connection data if you are not working with an encrypted One Identity Manager database and no synchronization project has been saved yet in the database. This page is not shown if a synchronization project already exists.
  2. The wizard loads the target system schema. This may take a few minutes depending on the type of target system access and the size of the target system.
  1. Select a project template on the Select project template page to use for setting up the synchronization configuration.
    Table 12: Default project template
    Project template Description
    OpenDJ Synchronization Project template based on OpenDJ. Use this project template for initially setting up the synchronization project. For custom implementations, you can extend the synchronization project with the .Synchronization Editor
    AD LDS Synchronization This project template is based on Active Directory Lightweight Directory Services (AD LDS).

    NOTE: A default project template ensures that all required information is added in the One Identity Manager. This includes mappings, workflows and the synchronization base object. If you do not use a default project template you must declare the synchronization base object in One Identity Manager yourself.Use a default project template for initially setting up the synchronization project. For custom implementations, you can extend the synchronization project with the .Synchronization Editor

  1. Specify how system access should work on the page Restrict target system access. You have the following options:
    Table 13: Specifying Target System Access
    Option Meaning

    Read-only access to target system.

    Specifies whether a synchronization workflow should be set up to initially load the target system into the One Identity Manager database.

    The synchronization workflow has the following characteristics:

    • Synchronization is in the direction of "One Identity Manager".
    • Processing methods in the synchronization steps are only defined in synchronization direction "One Identity Manager".

    Changes are also made to the target system.

    Specifies whether a provisioning workflow should be set up in addition to the synchronization workflow to initially load the target system.

    The provisioning workflow displays the following characteristics:

    • Synchronization in the direction of the "target system"
    • Processing methods are only defined in the synchronization steps in synchronization direction "target system".
    • Synchronization steps are only created for such schema classes whose schema types have write access.
  2. Select the synchronization server to execute synchronization on the Synchronization server page.

    If the synchronization server is not declare as a job server in the One Identity Manager database yet, you can add a new job server.

    • Click to add a new job server.
    • Enter a name for the job server and the full server name conforming to DNS syntax.
    • Click OK.

      The synchronization server is declared as job server for the target system in the One Identity Manager database.

      NOTE: Ensure that this server is set up as the synchronization server after saving the synchronization project.
  1. Enter the general setting for the synchronization project on the General page.

    NOTE: This step is only shown if the selected project template supports several script languages.
    Table 14: General Synchronization Project Properties
    Property Description
    Display name Display name for the synchronization project.
    Script language Language in which the scripts for this synchronization project are written.

    Scripts are implemented at various points in the synchronization configuration. Specify the script language when you set up an empty project.

    Important: The script language cannot be changed after the synchronization project has been saved.

    If you use a project template, the template's script language is used.

    Description Spare text box for additional explanation.
  1. Click Finish to complete the project wizard.

    This creates and allocates a default schedule for regular synchronization. Enable the schedule for regular synchronization.

    The synchronization project is created, saved and enabled immediately.

    NOTE: If the synchronization project is not going to be executed immediately, disable the option Activate and save the new synchronization project automatically.

    In this case, save the synchronization project manually before closing the Synchronization Editor.

    NOTE: The target system connection data is saved in a variable set, which you can change in the Synchronization Editor under Configuration | Variables if necessary.

To configure the content of the synchronization log

  1. To configure the synchronization log for target system connection, select the category Configuration | Target system.
  2. To configure the synchronization log for the database connection, select the category Configuration | One Identity Manager connection.
  3. Select General view and click Configure....
  4. Select the Synchronization log view and set Create synchronization log.
  5. Enable the data to be logged.

    NOTE: Certain content create a lot of log data.

    The synchronization log should only contain the data necessary for error analysis and other evaluations.

  6. Click OK.

To synchronize on a regular basis

  1. Select the category Configuration | Start up configurations.
  2. Select a start up configuration in the document view and click Edit schedule....
  3. Edit the schedule properties.
  4. To enable the schedule, click Activate.
  5. Click OK.

To start initial synchronization manually

  1. Select the category Configuration | Start up configurations.
  2. Select a start up configuration in the document view and click Execute.
  3. Confirm the security prompt with Yes.

NOTE: Following synchronization, employees are automatically created for user accounts in the default installation. If there are no account definitions for the domain at the time of synchronization, user accounts are linked to employees. However, account definitions are not assigned. The user accounts are, therefore, in a "Linked" state.

To select user accounts through account definitions

  1. Create an account definition.
  2. Assign an account definition to the domain.
  3. Assign the account definition and manage level to the user accounts in a "linked" state.
    1. Select the category LDAP | User accounts | Linked but not configured | <Domain>.
    2. Select the task Assign account definition to linked accounts.
Detailed information about this topic
  • One Identity Manager Target System Synchronization Reference Guide
Related Topics
Related Documents