{"id":17827,"date":"2016-08-02T06:52:49","date_gmt":"2016-08-02T06:52:49","guid":{"rendered":"http:\/\/apidocs.kore.com\/?post_type=docs&#038;p=4434"},"modified":"2022-10-05T15:30:11","modified_gmt":"2022-10-05T14:30:11","slug":"synchronizing-users-from-active-directory","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/bot-admin\/enrollment\/synchronizing-users-from-active-directory\/","title":{"rendered":"Synchronizing Users from Active Directory"},"content":{"rendered":"<section class=\"l-section wpb_row height_auto\"><div class=\"l-section-h i-cf\"><div class=\"g-cols vc_row type_default valign_top\"><div class=\"vc_col-sm-12 wpb_column vc_column_container\"><div class=\"vc_column-inner\"><div class=\"wpb_wrapper\">\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<p>As a Bots\u00a0Admin\u00a0or admin user, you can configure Kore.ai\u00a0to synchronize with your organizational <span class=\"wysiwyg-color-black\">LDAP\u00a0<\/span>Active Directory to enroll users\u00a0from your company into Kore.ai. On the <strong>Enrollment &gt; Directory sync\u00a0<\/strong>page, you can do the following:<\/p>\n<ul>\n<li>Use a cloud-based agent to connect to your Active Directory (AD) server<\/li>\n<li>Manually start synchronization with your company Active Directory<\/li>\n<li>Create exclusion rules used to prevent unwanted updates to existing users or groups<\/li>\n<li>Define distribution lists to import from Active Directory<\/li>\n<li>Define organizational units to import from Active Directory<\/li>\n<li>Set up an automated schedule for synchronization.<\/li>\n<\/ul>\n<p>Kore.ai can synchronize with your LDAP Active Directory to match the member information from your organization to include, for example, user profile data such as name, department, title, telephone number, location, and user status in the organization.<br \/>If a Kore.ai user leaves your company and is deactivated in Active Directory, Kore.ai can automatically deactivate the Kore.ai account during the next scheduled Active Directory synchronization. Your company&#8217;s Active Directory is never modified during synchronization.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<p class=\"note\">Note: Post v8.1, the support for Kore.ai Directory Agent for AD Sync has been discontinued. You can use the Cloud Connector option discussed in detail in this document or use the public APIs for synchronizing your users, <a href=\"\/docs\/bots\/api-guide\/api-list\/#Admin_APIs\" target=\"_blank\" rel=\"noopener noreferrer\">click here for details<\/a>.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<p><strong>Prerequisites<\/strong><\/p>\n<p>To configure Active Directory synchronization, you must:<\/p>\n<ol>\n<li>Have administrative access for\u00a0reading and executing actions on\u00a0your LDAP server.<\/li>\n<li>Familiarity with LDAP queries and LDAP server administration.<\/li>\n<li>Have a Microsoft Active Directory LDAP Server.<\/li>\n<\/ol>\n<p>Kore.ai offers a wizard-based approach that will take you through the process to set up access to an Active Directory and configure the synchronization process customized for your company. You can define synchronization for members, and if needed, distribution lists and organizational units.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h2 id=\"configure\"><span class=\"ez-toc-section\" id=\"Configuration\">Configuration<\/span><\/h2>\n<p>To configure Active Directory using the cloud-based connector, you must log on to the Bots Admin Console, and complete the following steps to access the configuration settings for your company Active Directory sync.<\/p>\n<ol>\n<li>In the <strong>Enrollment<\/strong> module, on the <strong>Directory Sync<\/strong> page, select <strong>Cloud-Based Connector<\/strong>.<\/li>\n<li>From the Configure section, click <strong>Configure<\/strong>.<br \/><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/35\/BAC-ADSync-config.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-23186\" src=\"\/wp-content\/uploads\/sites\/35\/BAC-ADSync-config.png\" alt=\"\" width=\"626\" height=\"352\" \/><\/a>\n<\/li>\n<li>The <strong>Configure Synchronization with your Company Directory<\/strong> dialog is displayed. Follow the steps given here to proceed.<\/li>\n<\/ol>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3><span class=\"ez-toc-section\" id=\"AD_Sync_Configuration\"><span class=\"wysiwyg-font-size-x-large\">AD Sync Configuration<\/span><\/span><\/h3>\n<p>Complete the steps in the following procedure to define the synchronization settings. If you have already defined your synchronization settings, you can modify the settings and initiate a manual sync.<\/p>\n<p class=\"note\">NOTE: If you are using a bot built on the platform from before v7.3, you will have an option to <strong>Upgrade<\/strong> or <strong>Configure<\/strong>. If you proceed to Configure without Upgrade the following options from the configuration steps will not be available:<br \/>-access to AD sub-Groups or option to create a group within Kore.ai for the OUs in AD;<br \/>-add custom fields to the user data by mapping it to the right key from the AD server incoming payload;<br \/>&#8211; specify the inclusion rules.<br \/>Also, the older version would be deprecated in the upcoming releases.<\/p>\n<p>In the following procedure, the cloud-based connection settings dialogs are described.<\/p>\n<ol>\n<li>On the <strong>Connection<\/strong> tab, define the following fields:\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/35\/EnrollmentDirectorySyncConfigTab.png\"><img loading=\"lazy\" decoding=\"async\" class=\"wp-image-6532 size-full alignnone\" src=\"\/wp-content\/uploads\/sites\/35\/EnrollmentDirectorySyncConfigTab.png\" alt=\"EnrollmentDirectorySyncConfigTab\" width=\"681\" height=\"257\" \/><\/a><\/li>\n<\/ol>\n<ol>\n<li><strong>Host Name<\/strong> &#8211; The name of the domain host, for example, <span class=\"InputOutput_Kore.ai\" style=\"color: #0000ff\">MyCompany.com<\/span> or\u00a0<span class=\"InputOutput_Kore.ai\" style=\"color: #0000ff\">10.12.6.151<\/span>.<\/li>\n<li><strong>Server Port<\/strong> &#8211; The port number for the domain host, for example, <span class=\"InputOutput_Kore.ai\" style=\"color: #0000ff\">10042<\/span>.<\/li>\n<li><strong>Base DN<\/strong> &#8211; The server location for users and groups in a domain, for example,\u00a0<span style=\"color: #0000ff\">dc<span class=\"InputOutput_Kore.ai\">=kore,dc=com<\/span><\/span>.<\/li>\n<li><strong>User ID<\/strong> &#8211; The username for authentication to connect to the domain controller.<\/li>\n<li><strong>Password<\/strong> &#8211; The password for authentication to connect to the domain controller.<\/li>\n<li><strong>SSL<\/strong> &#8211; Select to enable SSL for HTTPS.<\/li>\n<li><strong>Test Connection<\/strong> &#8211; Click to test the authentication and Host configuration settings.<\/li>\n<li>Click <strong>Save and next<\/strong> to continue.<\/li>\n<\/ol>\n<ul>\n<li>Optionally, on the <strong>Organizational Units<\/strong> tab, you can define the Org Units that need to be imported from your company directory. Groups and sub-groups from the selected OU will be synchronized into the platform and the hierarchy of groups as present in the AD Server will be maintained in the platform.\n<ol>\n<li>\u00a0You can choose to\n<ul>\n<li><em>Import all Organization Units<\/em>,<\/li>\n<li><em>Not Import any unit<\/em>, or<\/li>\n<li><em>Import specific units<\/em>.<\/li>\n<\/ul>\n<\/li>\n<li>. Click <strong>Save and next<\/strong> to continue.<\/li>\n<\/ol>\n<\/li>\n<li>Optionally, on the <strong>Distribution Lists<\/strong> tab, you can select to <strong>Import Distribution Lists from Active Directory<\/strong>.<\/li>\n<li>On the <strong>Users<\/strong> tab, you can define the desired User Attributes (profile fields) that need to be imported from your company directory. You can set import criteria, inclusion rules, and exclusion rules to control the information that you want to import from your organization.\n<ol>\n<li>On the <strong>User Attributes<\/strong> child tab you can import the user profile information\n<ul>\n<li>using predefined <strong>Default <\/strong>mapping of Kore.ai user profile fields to relevant LDAP attributes or<\/li>\n<li>create your own <strong>custom<\/strong> mapping with the Customer Attribute name and values.<\/li>\n<\/ul>\n<\/li>\n<li>On the\u00a0<strong>Inclusion Rules,<\/strong> you can sync select users from your AD Server by defining the sync criteria or filters using the profile parameters. You can write the rules using the LDAP filter syntax, <a href=\"https:\/\/social.technet.microsoft.com\/wiki\/contents\/articles\/5392.active-directory-ldap-syntax-filters.aspx\" target=\"_blank\" rel=\"noopener noreferrer\">refer here for more<\/a>.<\/li>\n<li>On the\u00a0<strong>Exclusion Rules<\/strong> child tab, you can create rules to limit incoming user records for the user (default and custom) data.\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/35\/BAC-ADSync-user3.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-23189\" src=\"\/wp-content\/uploads\/sites\/35\/BAC-ADSync-user3.png\" alt=\"\" width=\"561\" height=\"286\" \/><\/a><\/li>\n<\/ol>\n<\/li>\n<li>Optionally, on the <strong>Kore.ai Exclusions<\/strong> tab, you can define exclusions for synchronization to prevent Active Directory from replacing specific users (default and custom), distribution lists, or organizational groups.<br \/><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/35\/BAC-ADSync-exclusions.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-23190\" src=\"\/wp-content\/uploads\/sites\/35\/BAC-ADSync-exclusions.png\" alt=\"\" width=\"596\" height=\"278\" \/><\/a><\/li>\n<li>On the <strong>Schedule<\/strong> tab, enable and define the synchronization schedule with the Active Directory as shown in the following illustration.\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/35\/BotsAdminEnrollmentDirectorySyncScheduleTab-2.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-8231 size-full\" src=\"\/wp-content\/uploads\/sites\/35\/BotsAdminEnrollmentDirectorySyncScheduleTab-2.png\" alt=\"botsadminenrollmentdirectorysyncscheduletab\" width=\"574\" height=\"332\" \/><\/a><\/p>\n<ol>\n<li><strong>Enable Synchronization<\/strong> &#8211; Click to enable or disable a synchronization schedule.<\/li>\n<li><strong>Synchronization Frequency<\/strong> &#8211; Select one of:\n<ul>\n<li><strong>Daily<\/strong> &#8211; Specify the <strong>Start Synchronization<\/strong> date and time to begin the daily sync.<\/li>\n<li><strong>Weekly<\/strong> &#8211; Specify the day of the week to synchronize and the <strong>Start Synchronization<\/strong> date and time to begin the weekly sync.<\/li>\n<li><strong>Monthly<\/strong> &#8211; Specify the day of the month to synchronize and the <strong>Start Synchronization<\/strong> date and time to begin the monthly sync.<\/li>\n<li><strong>Other<\/strong> &#8211; Specify the number of <strong>DAY(S)<\/strong>\u00a0or <strong>WEEK(S)<\/strong> to synchronize and the\u00a0<strong>Start Synchronization<\/strong> date and time to begin the sync.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<\/li>\n<li>Click <strong>Save<\/strong> to save the synchronization settings and close the <strong>Configure Synchronization with your Company Directory<\/strong> dialog.<\/li>\n<\/ul>\n<p>You may want to view the results of Active Directory sync, <a href=\"#View_Report\">see here<\/a>.<\/p>\n<p>Notes regarding deleted users:<\/p>\n<ul>\n<li>Users who are deleted or marked as deleted in the AD Server will be deleted from the Bots Platform as well and will be not available in the list of users during AD sync process<\/li>\n<li>The user record will be retained in the database for any cross-reference and audit purposes<\/li>\n<li>Any login attempts by such users will be blocked by the system<\/li>\n<li>Deletion would be against a specific Account to which the user belongs to i.e. if the user is part of multiple accounts, then the user will be able to access any other accounts in which the user is still an active state<\/li>\n<li>The following user cannot be deleted from the account\n<ul>\n<li>User is Bot Owner for one or more bots<\/li>\n<li>User is Account Owner<\/li>\n<\/ul>\n<p>Such users will not be deleted from the account during the AD Sync process. The AD Sync logs will contain the list of such users who could not be deleted along with the reason.<\/p>\n<\/li>\n<\/ul>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h2 id=\"start\"><span class=\"ez-toc-section\" id=\"Manual_Sync\">Manual Sync<\/span><\/h2>\n<p>You may want to initiate manual sync with your Active Directory to update when there are many changes between scheduled syncs.<br \/>To complete this procedure, you must have already defined synchronization settings for your account.<\/p>\n<p>How you access the Active Directory Sync configuration depends which type of connector you are using. Complete one of the following procedures to access the Kore.ai Active Directory configuration dialog.<\/p>\n<p><strong>To manually start an Active Directory sync\u00a0<strong>using\u00a0the cloud-based connector<\/strong><\/strong><\/p>\n<ul>\n<li value=\"1\">In the\u00a0<strong>Enrollment<\/strong>\u00a0&gt;\u00a0<strong>Directory Sync<\/strong> page, in the\u00a0<strong>Current Settings<\/strong> section, click <strong class=\"UserInterface_Kore.ai\">Run Now<\/strong>\u00a0as shown in the following illustration.\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/35\/EntAdminEnrollmentDirectorySyncManualStart.png\"><img loading=\"lazy\" decoding=\"async\" class=\"wp-image-7866 size-full alignnone\" src=\"\/wp-content\/uploads\/sites\/35\/EntAdminEnrollmentDirectorySyncManualStart.png\" alt=\"Manually Start a Directory Sync\" width=\"638\" height=\"303\" \/><\/a><\/li>\n<\/ul>\n<p>The <em class=\"TitleOrPath_Kore.ai\">Directory Synchronization is in-progress<\/em> message is displayed at the top of the page.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h2 id=\"view\"><span class=\"ez-toc-section\" id=\"View_Report\">View Report<\/span><\/h2>\n<p>After you configure and run an Active Directory sync for your account, you should review the results of the sync. This topic describes how to access and view a report for the current Active Directory sync.<\/p>\n<p>How you access the last run results for your Active Directory sync runs depends which type of connector you are using. Complete one of the following procedures to access the last run results for Kore.ai Active Directory sync.<\/p>\n<p><strong>To view the last run report for an Active Directory sync using the c<strong><strong>loud-based connector<\/strong><\/strong><\/strong><\/p>\n<ul>\n<li>In the\u00a0Bots Admin Console\u00a0<strong class=\"UserInterface_Kore.ai\">Enrollment<\/strong> module, on the <strong class=\"UserInterface_Kore.ai\">Directory Sync<\/strong> page, click <span style=\"color: #0000ff\">here<\/span> as shown in the following illustration.\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/35\/EntAdminEnrollmentDirectorySyncReportLatestSYnc.png\"><img loading=\"lazy\" decoding=\"async\" class=\"wp-image-7876 size-full alignnone\" src=\"\/wp-content\/uploads\/sites\/35\/EntAdminEnrollmentDirectorySyncReportLatestSYnc.png\" alt=\"Latest Sync Report - Cloud Connector\" width=\"528\" height=\"274\" \/><\/a><\/li>\n<\/ul>\n<h4><span class=\"wysiwyg-font-size-x-large\">Viewing the Last Run Report<\/span><\/h4>\n<p>The <strong class=\"UserInterface_Kore.ai\">Report on Active Directory Sync<\/strong> dialog is displayed as shown in the following illustration.<\/p>\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/35\/view-report-on-active-directory-sync_3.png\"><img loading=\"lazy\" decoding=\"async\" class=\"wp-image-7879 size-full alignnone\" src=\"\/wp-content\/uploads\/sites\/35\/view-report-on-active-directory-sync_3.png\" alt=\"View Report\" width=\"906\" height=\"626\" \/><\/a><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h2 id=\"view-hist\"><span class=\"ez-toc-section\" id=\"View_History\">View History<\/span><\/h2>\n<p>You can review all historical Active Directory sync operations along with the results of that sync. This topic describes how to access the report and how to retrieve details about the synchronization.<\/p>\n<p>How you access the history for your Active Directory sync runs depends which type of connector you are using. Complete one of the following procedures to access the history results for Kore.ai Active Directory sync.<\/p>\n<p><strong>To view historical reports for Active Directory sync using the cloud-based connector<\/strong><\/p>\n<ul>\n<li>In the\u00a0Bots Admin Console\u00a0<strong>Enrollment<\/strong> module, on the <strong>Directory Sync<\/strong> page, in the\u00a0<strong>Current Settings<\/strong> section, click <span style=\"color: #0000ff\"><em>Sync History<\/em><\/span> as shown in the following illustration.\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/35\/BotsAdminEnrollmentDirectorySyncManualStartSyncHistory.png\"><img loading=\"lazy\" decoding=\"async\" class=\"wp-image-8029 size-full alignnone\" src=\"\/wp-content\/uploads\/sites\/35\/BotsAdminEnrollmentDirectorySyncManualStartSyncHistory.png\" alt=\"Cloud Connector Directory Sync Results\" width=\"638\" height=\"303\" \/><\/a><\/li>\n<\/ul>\n<h4><span class=\"wysiwyg-font-size-x-large\">Viewing a Report<\/span><\/h4>\n<p>In the <strong>History of Active Directory Synchronization Runs<\/strong> dialog, to view the results of an import, in the\u00a0<strong>Report<\/strong> column for the import that you want to view, click <span class=\"wysiwyg-color-blue90\"><span class=\"wysiwyg-color-blue80\" style=\"color: #0000ff\">Sync Results<\/span>.<\/span><\/p>\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/35\/EntAdminEnrollmentDirectorySyncAgentSectionSyncHistoryResults.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-7872 size-full\" src=\"\/wp-content\/uploads\/sites\/35\/EntAdminEnrollmentDirectorySyncAgentSectionSyncHistoryResults.png\" alt=\"Directory Sync Results Dialog\" width=\"732\" height=\"654\" \/><\/a><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"As a Bots\u00a0Admin\u00a0or admin user, you can configure Kore.ai\u00a0to synchronize with your organizational LDAP\u00a0Active Directory to enroll users\u00a0from your company into Kore.ai. On the Enrollment &gt; Directory sync\u00a0page, you can do the following: Use a cloud-based agent to connect to your Active Directory (AD) server Manually start synchronization with your company Active Directory Create exclusion...","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[30],"tags":[],"class_list":["post-17827","post","type-post","status-publish","format-standard","hentry","category-enrollment"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/17827","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=17827"}],"version-history":[{"count":15,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/17827\/revisions"}],"predecessor-version":[{"id":48268,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/17827\/revisions\/48268"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=17827"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=17827"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=17827"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}