Parent page: Managing Users
To simplify the process of connecting to and accessing company networks, the Altium Infrastructure Server facilitates directory services support through its browser interface.
This offers domain user synchronization based on the Lightweight Directory Access Protocol (LDAP), which queries the network’s central LDAP server to retrieve domain user group and role membership information. Authenticating domain users through established directory services in this way offers the potential of a single login for access to all company systems, including the Altium Infrastructure Server.
The Infrastructure Server LDAP synchronization queries the network services on a user role basis, where role membership information is gathered for Infrastructure Server user access authorization. Polling the domain membership through the LDAP service (synchronizing) allows the system to respond to a domain user configuration change within a synchronization cycle.
An LDAP Sync allows the administrator of an Altium Infrastructure Server to leverage the network domain’s existing username and password credentials, so that user credentials do not have to be created manually one at a time on the USERS page of the Infrastructure Server's browser-based interface. When setup correctly, the USERS page will automatically populate with user credentials, enabling any user listed to sign into the Altium Infrastructure Server using their regular corporate network username and password.
This article details a proven approach that has been successfully used in setting up an LDAP Sync on a domain. Try this approach when setting up an LDAP Sync on your own domain.
When configuring an LDAP Sync task through the Altium Infrastructure Server's bowser-based interface, you need to supply the LDAP Distinguished Name (DN). This is entered in string format, and identifies the base object of the LDAP search. To get this string, we're going to use the LDAP Admin utility, so first ensure the zip file is downloaded, and extract out the LdapAdmin executable therein.
Run the LdapAdmin.exe executable as Administrator (just right-click on it and select Run as administrator).
When the LDAP Admin panel opens, choose Start » Connect to access the Connections dialog, then double-click New connection to access the Connection properties dialog.
On the General tab of the Connection properties dialog, configure the connection information in relation to your domain, an example of which might be:
With the connection properties configured, press the Test connection button. If all is set correctly, you should see the Connection is successful message. Click OK to finish creating the new connection.
You now need to identify the string that targets the base object of the LDAP search. To do this:
At this point, the LDAP Admin utility is no longer required for any further steps.
Now, let’s focus on the Altium Infrastructure Server. Sign into the target Altium Infrastructure Server - through its browser-based interface - as an Administrator. If you are intending to create user credentials from LDAP automatically, then you probably want to remove any existing manually created users. So ideally just start with the default Administrator's role users - admin and System.
If you want the users from the LDAP Sync to be associated with a specific role, you can switch to the Roles tab and create a new role as required, leaving it empty of users. For our example, we'll create a role called Managers.
Fill in the following information (based on our example domain structure we have used in the previous section):
For example, consider if there had been a set of users under the group of Managers, gathered to have administrative powers (CN=Administrators). To target just this set of users, and not all of the Managers (under the OU=Managers area of the domain structure), a query string could be written that targets this point in the domain structure:
When you have completed entering all settings, click . This will initiate the Sync process, which may take a minute or two, as it processes the information you just entered. Watch the Sync status messages at the top of the LDAP Sync page, to see when the process completes.
Now click on the Users tab. This list should now be populated with all users as defined by the OU=<GroupName> setting (see example image below). Now anyone can sign into the Altium Infrastructure Server using their regular Windows login.