Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
tutorial:adm:manage_ad [2018/07/24 13:59] apeterova generating schema needs top container |
tutorial:adm:manage_ad [2021/06/25 12:41] soval [Forced password change (User must change password at next logon)] |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== Systems - AD: Manage users ====== | ||
+ | ===== Introduction ===== | ||
+ | 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. | ||
+ | You can as well use [[tutorial: | ||
+ | |||
+ | ===== Before you start ===== | ||
+ | ==== Adding Active Directory connector ==== | ||
+ | Since CzechIdM 9.2, the [[https:// | ||
+ | |||
+ | ==== Preparing Active Directory ==== | ||
+ | You must prepare your Active Directory for the CzechIdM integration, | ||
+ | * 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 '' | ||
+ | |||
+ | * CzechIdM needs to '' | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | 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 '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | 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 '' | ||
+ | - Right-click a container (in our case it was simply marked '' | ||
+ | - Choose '' | ||
+ | - Choose the '' | ||
+ | - Choose '' | ||
+ | - Choose '' | ||
+ | - Tick the '' | ||
+ | - Check the summary and finish the wizard. Changes are effective immediately. | ||
+ | - Repeat for other subtrees as necessary. | ||
+ | |||
+ | <note important> | ||
+ | **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 '' | ||
+ | However this requirement is not transitive in groups hierarchy. | ||
+ | In AD, you have a '' | ||
+ | But the '' | ||
+ | |||
+ | If you want to manage your users and their group membership, you therefore need to grant full control on '' | ||
+ | |||
+ | But you **do not need** to grant anything on '' | ||
+ | </ | ||
+ | ===== Basic configuration ===== | ||
+ | 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. | ||
+ | |||
+ | ===== Connector configuration ===== | ||
+ | |||
+ | In next step switch to menu **Configuration** of your new system. At first, you need to chose connector, which in this case is **net.tirasa.connid.bundles.ad.ADConnector(connId)**. It will open specific configuration for that choice. | ||
+ | |||
+ | Thereafter fill important fields. | ||
+ | |||
+ | **Example configuration for our local AD:** | ||
+ | |||
+ | * **SSL** - this is strongly advised to enable and also vital for managing the users' password | ||
+ | * **Server hostname** - hostname of the AD domain controller. (IP address could be used as well, but then it must be stated in the server' | ||
+ | * **Server port** - typically 636. (389 if not using SSL) | ||
+ | * **Failover** - an optional list of other domain controllers used in the case that the primary server is not available. Use URL format ''< | ||
+ | * **Principal** - login@domain of the user with admin privilege that CzechIdM will use for the connection. DN of the user works 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=company, | ||
+ | * **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, | ||
+ | * **Base contexts for group entry searches** - containers in AD where the groups are located. This must be specified if the groups are in different container than people and the group container is not under the path which is in "Root suffixes" | ||
+ | * **Base contexts for user entry searches** - usually the same as "Root suffixes" | ||
+ | * **Group members reference attribute** - typically " | ||
+ | * **useVlvControls** - enable the option. (This option is only available if you use connector that is customized by BCV solutions) | ||
+ | * **pageSize** - we advise to set it to **100**. If you let the default 0, or ask for more than the limit for AD is, you will get an error when reading accounts. (This option is only available if you use connector that is customized by BCV solutions) | ||
+ | * **vlvSortAttribute** - set to " | ||
+ | * **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 " | ||
+ | * **Object classes to synchronize** - usually the same as "Entry object classes" | ||
+ | * **Specified attributes to be returned** - default " | ||
+ | |||
+ | <note warning> | ||
+ | |||
+ | <note important> | ||
+ | ];" error</ | ||
+ | |||
+ | <note important> | ||
+ | <note important> | ||
+ | |||
+ | ===== Scheme ===== | ||
+ | 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\__, | ||
+ | {{ : | ||
+ | |||
+ | 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' | ||
+ | |||
+ | 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 sometimes not generated by default (mainly if it isn't used as Uid). If so, you must create it manually. Use the button **Add**, fill in the name " | ||
+ | * \_\_ENABLE\_\_ - if you want to allow disabling a user in AD. This attribute is not generated by default, so you can create it manually. Use the button **Add**, fill in the name " | ||
+ | * \_\_NAME\_\_ (synonymous to DN, hard-coded in the connector). This attribute should be generated by default. If not, use the button **Add**, fill in the name " | ||
+ | * \_\_PASSWORD\_\_ - this special attribute is used for setting the passwords for user accounts. User in AD can't be activated when a password is not set. This attribute is not created by default in the schema, so you must add it manually: name " | ||
+ | * ldapGroups - use this attribute if you want to manage users' group membership. This attribute is not created by default, add it manually: name " | ||
+ | |||
+ | <note tip>You do not need to use all of the schema attributes for provisioning afterwards</ | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | <note tip>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.</ | ||
+ | |||
+ | |||
+ | ===== Mapping ===== | ||
+ | |||
+ | 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 | ||
+ | |||
+ | <note tip>It is strongly advised to use **sAMAccountName** 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\_\_**, | ||
+ | |||
+ | 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 '' | ||
+ | |||
+ | ==== Password mapping ==== | ||
+ | |||
+ | If you want to send passwords into Active Directory, you need to configure SSL communication. | ||
+ | |||
+ | To enable passwords provisioning, | ||
+ | * Attribute in schema - \_\_PASSWORD\_\_, | ||
+ | * Name - \_\_PASSWORD\_\_ | ||
+ | * Entity attribute - false | ||
+ | * Attribute with password - true | ||
+ | |||
+ | ==== Forced password change (User must change password at next logon) ==== | ||
+ | When mapping AD attributes, it is sometimes useful to be able to set a forced password change option. This requirement is often set for two different cases: | ||
+ | |||
+ | * We need to change the password when logging into AD **for a new user account** | ||
+ | * We need to force a password change but **only after a password reset** | ||
+ | |||
+ | 1/ To force a password change for newly created users, map the **" | ||
+ | |||
+ | |||
+ | 2/ If we need to force password change every time password is reset, map attribute pwdLastSet too, but **with checkbox " | ||
+ | |||
+ | {{: | ||
+ | |||
+ | ===== Role for AD ===== | ||
+ | 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 [[tutorial: | ||
+ | |||
+ | Then in the role detail, go the the menu tab **Systems**, | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | 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 " | ||
+ | |||
+ | <note important> | ||
+ | |||
+ | |||
+ | ====== 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 named **ldapGroups**. Make sure, it can be read, | ||
+ | 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, | ||
+ | |||
+ | 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, make sure to use the same as in the provisioning mapping). 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. | ||
+ | |||
+ | For managing group membership in multi domain AD environment follow [[tutorial: | ||
+ | |||
+ | <note important> | ||
+ | |||
+ | ====== Tips & Tricks ====== | ||
+ | |||
+ | ===== Distinguished Name (DN), Common Name (CN) ===== | ||
+ | |||
+ | 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. | ||
+ | |||
+ | < | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | 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. | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | ===== ldapGroups not returned ===== | ||
+ | |||
+ | If you are running on a Windows server, the ' | ||
+ | |||
+ | ===== Mapping extensionAttributes ===== | ||
+ | |||
+ | AD enables additional attributes named extensionAttribute1 - extensionAttribute10. If you want to fill these attributes by IdM, you must do following steps in the configuration of the connected system: | ||
+ | * Go to **Configuration** -> **Specified attributes to be returned (multi)**, add **extensionAttribute1** to a new line under existing values. | ||
+ | * Go to **Scheme** -> **\_\_ACCOUNT\_\_** -> use the button **Add**, fill in the name **extensionAttribute1**, | ||
+ | * Go to **Mapping** -> **Provisioning mapping** -> use the button **Add** and map the attribute according to your choice. The following example can be used when you want to fill the extensionAttribute1 by personal numbers of identities | ||
+ | * Attribute in schema - extensionAttribute1 | ||
+ | * Name - extensionAttribute1 | ||
+ | * Entity attribute - true | ||
+ | * Entity field - Personal number | ||
+ | |||
+ | ===== Connection via SSL not working ===== | ||
+ | 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. | ||
+ | |||
+ | ===== LdapErr: DSID-0C0907C5 ===== | ||
+ | If you see this error when reconciliating AD groups: | ||
+ | < | ||
+ | |||
+ | the likely cause is that some groups have many members. AD has a property MaxPageSize which is probably set to lower than necessary (default is 1000). Increasing the value to an arbitrary large number (30000) helped in our case but only AD admin can change this. | ||
+ | |||
+ | ===== SvcErr: DSID-031007E5 - unsupported special characters in DN ===== | ||
+ | |||
+ | The AD connector doesn' | ||
+ | < | ||
+ | javax.naming.NamingException: | ||
+ | </ | ||
+ | |||
+ | Please rename your containers so they don't contain special characters. | ||
+ | |||
+ | See more about this known issue here: https:// | ||
+ | |||
+ | ===== Failover ===== | ||
+ | |||
+ | The configuration property Failover is used when the primary server (configured in the Server hostname) is unavailable. The attribute contains a list of AD servers that connector can use. | ||
+ | |||
+ | Please note that this property is not used in the case that the primary server is accessible on the given port, but there is some other problem with the communication (e.g. the credentials are incorrect). | ||
+ | |||
+ | The value of this property must be a proper URL, e.g. ''< | ||
+ | |||
+ | |||
+ | ===== Video Guide ===== | ||
+ | [[https:// |