Systems - AD: Manage users

This tutorial uses AD bundle connector, which is OBSOLETE. Since CzechIdM v 9.7.x, it is advised to use our new AD+Powershell connector

This tutorial will show you how to connect AD as a target system for users (their accounts) from CzechIdM. We will use an AD bundle connector from Connid.

Adding Active Directory connector

First of all, you need to download the connector from Connid (e.g. Connid AD bundle 1.3.4 jar file). Then add the jar file into CzechIdM folder inside the application server. In case you installed CzechIdM into tomcat by standard installation, the path would be /opt/tomcat/current/webapps/idm/WEB-INF/lib/.

To preserve the connector during future upgrades of CzechIdM core, put the connector in e.g. /opt/czechidm/lib/ and create symbolic link in the CzechIdM webapp folder:
ln -s /opt/czechidm/lib/ /opt/tomcat/current/webapps/idm/WEB-INF/lib/

Then restart the application server. If you had CzechIdM already running in the web browser, refresh also the web browser window (e.g. Ctrl+F5).

Preparing Active Directory

You must prepare your Active Directory for the CzechIdM integration, mainly:

  • Enable LDAPS (SSL-protected LDAP protocol) on the AD. This is vital for production deployments. Also, CzechIdM will not manage users' passwords if not connected to AD through LDAPS.
  • Create an user account for the CzechIdM. Identity manager will use this account to perform operations on your AD. Although you can use a Domain Administrator account, we highly discourage it.
    • This is simply a Domain User account like any other, but you should create it in different subtree than you want to manage through IdM.
  • Grant the CzechIdM user permissions on your AD.

Granting permissions

Suppose we have a domain PISKOVISTE.BCV with corresponding domain components DC=piskoviste,DC=bcv and the IdM application user is CzechIdM (czechidm@piskoviste.bcv).

  • CzechIdM needs to read AD configuration and schema subtrees. In our case:
    • CN=Configuration,DC=piskoviste,DC=bcv
    • CN=Schema,CN=Configuration,DC=piskoviste,DC=bcv

Ability to read schema and sufficient AD configuration should be there by default for an authenticated user. Probably no need to adjust it.

  • CzechIdM needs full control on subtrees which it will manage. Suppose we need to manage users, groups and computers and that we have a fairly simple setup. We grant full control to those subtrees:
    • CN=Computers,DC=piskoviste,DC=bcv
    • CN=Users,DC=piskoviste,DC=bcv
    • OU=Groups,DC=piskoviste,DC=bcv

Which subtrees you need to grant privileges on depends on the actual directory tree of your Active Directory.

Granting full control to CzechIdM application user

The process is fairly straightforward. Just repeat it for every root of every subtree you need to grant the rights on.

  • Open the Active Directory Users and Computers.
  • Right-click a container (in our case it was simply marked Users).
  • Choose Delegate Control.
  • Choose the CzechIdM (czechidm@piskoviste.bcv) user.
  • Choose Create a custom task to delegate.
  • Choose This folder, existing objects in this folder, and creation of new objects in this folder.
  • Tick the Full Control checkbox. This will tick all possible checkboxes in the dialog window.
  • Check the summary and finish the wizard. Changes are effective immediatelly.
  • Repeat for other subtrees as necessary.
CzechIdM has to have access to objects directly referenced from objects you manage.

For example:

A user is member of some groups, this is noted in his member attribute. If you want to manage the member attribute, the CzechIdM also has to have full access to the subtree with user groups. However this requirement is not transitive in groups hierarchy. In AD, you have a Groups\Domain Users group and every domain user is a member of this group. This means that every domain user has a member attribute which contains the Groups\Domain Users group DN. But the Groups\Domain Users is itself a member of Builtin\Users group.

If you want to manage your users and their group membership, you therefore need to grant full control on Users (to manage users) and Groups (because this is where Domain Users group is) even if you do not want to manage groups themselves. This is because of consistency checks performed by CzechIdM upon account provisioning.

But you do not need to grant anything on Builtin because this is referenced from an user account only indirectly.

Go to Systems from main menu, then above list of current systems use Add button. On the first page just fill system name.

On the same page you may need to set new password policy in case that your default policy does not meet all requirements of AD configuration. If you do not want to generate passwords for AD accounts, you can skip this step at all.

In next step switch to menu Configuration of your new system. At first, you need to chose connector, which in this case is It will open specific configuration for that choice.

Thereafter fill important fields.

Example configuration for our local AD:

  • Server hostname - hostname or IP
  • Server port - usually 389 or 636
  • Principal - login of the user with admin privilege that CzechIdM will use for the connection. DN of the user should work too.
  • Principal password - password of the administrator user
  • Root suffixes - the list distinguished names of the roots that connector uses for managing users. If you do not want to manage some account, it is advised not to include them in the Root suffixes. When you configure the system for the first time, root suffix should lead to the top container (e.g. DC=aktest,DC=local), so the system schema can be correctly generated.
  • User search scope - manage users in specified container or subtrees. Usually subtree
  • Entry object classes - only objects (accounts) with object classes specified there will be managed. Each object class on new line, no comma or another separator. Usual values: top, person, organizationalPerson, user.
  • Base contexts for group entry searches - container in AD where the groups are located. If the groups are in different container then people and the group container is not under the path which is in "Root suffixes". You need to put it here, otherwise connector will not be able to load users groups
  • Base contexts for user entry searches - usually the same as "Root suffixes".
  • Group members reference attribute - usually "member", use this if you want to manage group membership of user accounts
  • pageSize - this option is only available if you use connector that is customizes by BCV Solutions. Leave it at default (100), if you ask for more than the limit for AD is, you will get an error.
  • Uid Attribute - this is one of the most important option. It defines the primary key/UID of the account. Attribute values will be stored in CzechIdM for each account. Must be unique and should not change. It is strongly advised to use "sAMAccountName", since connId connector has some problem with returning this specific attribute if mapped by other means.
  • Object classes to synchronize - usually the same as "Entry object classes"
Beware on useVlvControls option. CzechIdM now only supports vlv control, so useVlvControls option should be enabled and vlvSortAttribute must be set (recommended option - 'sAMAccountName').
Since connector version we support change of sAMAccount name, even if it is used as identifier (in provisioning mapping use sAMAccountName instead of __Uid__)
Since connector version we support objectGUID as identifier, but only with this property turned off:

(in create action you have to send random String, because UID cannot be null and objectGUID will be obtained after create of user/group)

For next step, go to menu Scheme on your system.

You can let CzechIdM generate a scheme for you by clicking on Generate scheme button and that is also the preferred way. For MS AD, the connector usually creates 3 object types. _ACCOUNTS_, _ALL_, _GROUP_.  Schema generation

For user management, we will use ACCOUNT. Click on the detail of the object type and check that the scheme attributes list consists of all attributes you want to manage in AD. If the list doesn't contain any attribute, check that Root suffixes in the system configuration contains the value of the top container (so the connector can read the schema definitions).

If you are connecting AD for the first time, it is a good idea to check some minimal set of attributes that allows you to create an account, which is usually:

  • sAMAccountName - this attribute is not sometimes generated by default. If so you must create it manually. Use the button Add, fill in the name "sAMAccountName", type "java.lang.String", able to read, update, create and returned by default.
  • __ENABLE__ - if you want to allow disabling a user in AD. Sometimes this attribute is not generated by default, so you can create it manually.
  • __NAME__ (synonymous to DN, hard-coded in the connector).
You do not need to use all of the schema attributes for provisioning afterwards

If you want to set everything by yourself:

  • Use button Add to create a new scheme. For users, you need to name it "__ACCOUNT__", because it is a Connid constant
  • Add all attributes that you want to work with. As a minimum, the "__NAME__" and "sAMAccountName" attributes should be mapped.
  • Set all attributes as Able to read, update, create.
It is possible you will not see the full scheme even with root suffix set to the top container. In that case, check that schemas are not stored separately and if they are, set root suffixes to the appropriate DC.

Now go to menu Mapping. There you must set, which attribute from scheme is mapped to which attribute in CzechIdM.

At first set:

  • Operation type: Provisioning - we want to manage data in AD from CzechIdM
  • Object name: __ACCOUNT__ - this is a standard type of scheme object in AD
  • Entity type: Identity - this entity type in CzechIdM we want to provision
  • As Mapping name set whatever you want, for example AD users prov mapping.

Then map scheme attributes to entity attributes as described below:

  • sAMAccountName
    • Name - sAMAccountName
    • Identifier - true
    • Entity attribute - true. Means that the attribute will be filled from basic Identity attribute set.
    • Entity field (selectbox) - User name
It is strongly advised to use __UID__ as an identifier, so that the identifier of the connector is the same as the identifier of the provisioning. Then some advanced CzechIdM features can be used and the debugging is also much easier

Other options may stay with default values.

__ENABLE__, mapping configuration is almost the same as __UID__, but do not set it as identifier. Map this schema attribute to entity attribute "Disabled". You should also add transformation to the system, because CzechIdM holds the attribute "disabled" and AD has attribute "enable". So the transformation should return opposite value of the attribute in CzechIdM. To do so, click on the Insert script button in "Transformation to system" window and find the script getOppositeBoolean. This should fill the window with the script call.

If you also want to create entities in AD, which is probable, map __NAME__ attribute that holds the DN of the account in AD. The configuration of the attribute may look like:

  • Attribute in schema - __NAME__,
  • Name - DN(__NAME__)
  • Entity attribute - true
  • Entity field - user name. In case that the DN on AD consists of the login of the user. Otherwise, you should choose other attribute or EAV.
  • The form of the DN varies on each instance of AD, so there usually will be some transformation to system like return "CN=" + attributeValue + ",OU=employees,DC=yourcompany,DC=com" . Of course your tree can be more complex, in that case you should follow some of our tutorials.

Password mapping

If you want to send passwords into Active Directory, you need to configure SSL communication.

When the mapping is set, the last step is to define a role in CzechIdM, that grants the user the account in AD. Prepare a new role in CzechIdM only with basic attributes. Name should be sufficient.

If you want some more options, follow How to create a role.

Then in the role detail, go the the menu tab Systems, add a new system and choose previously created one - "AD users and roles". Then also choose your provisioning mapping, there should be only one, and save it.

From now on, every time user gets the role, it is provisioned into the connected system AD. You can see that on users detail menu tab "Provisioning" or in the audit "Provisioning"

Finally, go to menu Provisioning and add new one set its Name and these fields:

  • Allowed: true
  • Set of mapped attributes: Select mapping from previous step.
  • Correlation attribute: __NAME__

You can leave the rest of configuration at the default values.

Group membership

If you want to add a user to an AD group via CzechIdM, you need appropriate Role there. So create a role that is almost similar to AD - Users above. Give it some better name that represents the group in AD, good idea is to use sAMAccountName or CN e.g. CRM basic user.

In the system AD - users schema setting, you need to have a special attribute defined that add the user to the group. The attribute is usually ldapGroups. Be sure, it can be read,create,update,delete. Attribute is multivalued. In the system configuration tab, there are some configuration properties, that must be set in order to allow group membership management.

  • Group members reference attribute - usually member. This represents the name of the attribute in AD that is present in Group. Its value is usually a DN of the user in the group.

Then continue to AD - users Mappings and edit provisioning mapping. Add there a ldapGroups attribute. It is not filled from any identity attribute and has no transformation. (It will be filled from the role). Since the attribute is multivalued, its filling strategy must be either MERGE or AUTHORITATIVE MERGE.

Get back to your role CRM basic user. In the tab Systems add a system AD - users and roles, save it. Then add an attribute that will be filled by this role - ldapGroups. Again choose the filling strategy MERGE or AUTH.MERGE. Then add a transformation that is the value of DN of the group in AD ' " ' sign on each side of the text.

Thus every user that has the role assigned is added to the group with provided DN via ldapGroups attribute.

Merge was fixed in connector version Before Merge behaved like Authoritative Merge

Tips & Tricks

You can easily find DN of a user account with the help of Active Directory Users and Computers in your Windows server. Open the user's detail and switch to the tab Attribute Editor. You can see here the attributes in the same format as IdM sees them.

If you do not see the Attributes editor, you have to switch it on. Go to Active Directory Users and CommputersView and select Advanced features.

 Attributes editor

Moreover, CN of the user account is the same as Name so you can see it on the first page of the user's detail next to the icon.

 CN = Name

If you just imported root certificate to IdM truststore, but SSL connection to AD is still not working try following method to find which server hostname you should use. Configure connection via SSL to AD in Apache Directory Studio during connection you will see this window: click on View certificate → tab General → field Issued To → Common name(CN) and use this value as server hostname.