Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
tutorial:adm:manage_ad [2019/09/06 08:32]
poulm obsolete tutorial
tutorial:adm:manage_ad [2020/01/15 06:22] (current)
cirkval [Failover]
Line 1: Line 1:
 ====== Systems - AD: Manage users ====== ====== Systems - AD: Manage users ======
-<note warning>​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</​note>​ 
  
 ===== Introduction ===== ===== 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.+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.
  
 ===== Before you start ===== ===== Before you start =====
  
 ==== Adding Active Directory connector ==== ==== Adding Active Directory connector ====
 +
 +<note warning>​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</​note>​
  
 First of all, you need to download the connector from Connid (e.g. [[http://​repo1.maven.org/​maven2/​net/​tirasa/​connid/​bundles/​net.tirasa.connid.bundles.ad/​1.3.4/​net.tirasa.connid.bundles.ad-1.3.4.jar| Connid AD bundle 1.3.4 jar file]]). First of all, you need to download the connector from Connid (e.g. [[http://​repo1.maven.org/​maven2/​net/​tirasa/​connid/​bundles/​net.tirasa.connid.bundles.ad/​1.3.4/​net.tirasa.connid.bundles.ad-1.3.4.jar| Connid AD bundle 1.3.4 jar file]]).
Line 86: Line 87:
   * **Server hostname** - hostname or IP   * **Server hostname** - hostname or IP
   * **Server port** - usually 389 or 636   * **Server port** - usually 389 or 636
 +  * **Failover** - an optional list of other domain controllers used in the case that the primary server is not available. Use URL format ''<​nowiki>​ldaps://​123.456.789.012:​636</​nowiki>''​.
   * **Principal** - login of the user with admin privilege that CzechIdM will use for the connection. DN of the user should work too.   * **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   * **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.   * **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   * **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, ​inetOrgPerson,​+  * **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 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"​.   * **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   * **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. ​It is advised to use number higher that number of accounts. E.g. 10000 for hundreds of 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.**   * **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"​   * **Object classes to synchronize** - usually the same as "Entry object classes"​
 +  * **Specified attributes to be returned** - default "​ldapGroups"​ and "​sAMAccountName"​
 +
 +<note warning>​If you are setting this on a Windows server, make sure to delete the '​Specified attributes to be returned'​ values and write them manually. Otherwise, ldapGroups will not be returned. </​note>​
  
 <note important>​Beware on **useVlvControls** option. CzechIdM now only supports vlv control, so **useVlvControls** option should be enabled and **vlvSortAttribute** must be set (recommended option - '​sAMAccountName'​).</​note>​ <note important>​Beware on **useVlvControls** option. CzechIdM now only supports vlv control, so **useVlvControls** option should be enabled and **vlvSortAttribute** must be set (recommended option - '​sAMAccountName'​).</​note>​
Line 126: Line 131:
   * Add all attributes that you want to work with. As a minimum, the "​**\_\_NAME\_\_**"​ and "​**sAMAccountName**"​ attributes should be mapped.   * 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**. ​   * Set all attributes as **Able to read, update, create**. ​
 +
 +<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.</​note>​
 +
 +<note warning>​In order to activate a user in AD, you must send a password. The attribute password is not created by default in the schema, so you must add it manually: name<​nowiki>​ "​__PASSWORD__",​ </​nowiki>​type "​eu.bcvsolutions.idm.core.security.api.domain.GuardedString"​.
 +If you want to use the workflow for groups synchronization,​ you must also create an attribute in schema, this time called "​ldapGroups",​ type "​java.lang.String"​.</​note>​
  
 ===== Mapping ===== ===== Mapping =====
Line 213: Line 223:
  
 {{ :​tutorial:​adm:​ad_user_properties_general.png | CN = Name }} {{ :​tutorial:​adm:​ad_user_properties_general.png | CN = Name }}
 +
 +===== ldapGroups not returned =====
 +
 +If you are running on a Windows server, the '​ldapGroups'​ in '​Specified attributes to be returned'​ has the wrong value '​ldapGroups\r'​ (this is only visible in Audit). The solution is to remove the value in '​Specified attributes to be returned'​ and write it again manually.
  
 ===== Connection via SSL not working ===== ===== Connection via SSL not working =====
Line 219: Line 233:
 {{:​tutorial:​adm:​trust.png?​400|}} {{:​tutorial:​adm:​trust.png?​400|}}
 click on View certificate -> tab General -> field Issued To -> Common name(CN) and use this value as server hostname. 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:
 +<​code>​org.identityconnectors.framework.common.exceptions.ConnectorException:​ javax.naming.OperationNotSupportedException:​ [LDAP: error code 12 - 00000057: LdapErr: DSID-0C0907C5,​ comment: Error processing control, data 0, v1db1]; remaining name '​OU=BohemiaEnergy,​DC=bohemiaenergy,​DC=local'</​code>​
 +
 +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.
 +
 +===== 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. ''<​nowiki>​ldaps://​some.hostname:​636</​nowiki>''​.
  
 ===== Video Guide ===== ===== Video Guide =====
 [[https://​www.youtube.com/​watch?​v=ZbQCH_BYd-k&​list=PLBeAQt3pe3EcdVE8QpCDEJcDsi_jtNQUb&​index=7|How to create role for AD group]] - czech language [[https://​www.youtube.com/​watch?​v=ZbQCH_BYd-k&​list=PLBeAQt3pe3EcdVE8QpCDEJcDsi_jtNQUb&​index=7|How to create role for AD group]] - czech language