{"id":17855,"date":"2016-08-08T09:13:21","date_gmt":"2016-08-08T09:13:21","guid":{"rendered":"http:\/\/apidocs.kore.com\/?post_type=docs&#038;p=4824"},"modified":"2021-08-31T06:06:08","modified_gmt":"2021-08-31T05:06:08","slug":"security-module-overview","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v9-0\/docs\/bots\/bot-admin\/security-control\/security-module-overview\/","title":{"rendered":"Security &amp; Control Module Overview"},"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>In the <strong>Security &amp; Control\u00a0<\/strong>module of the Kore.ai Bots Admin Console,<\/p>\n<ul>\n<li>configure Single Sign-On (SSO) authentication for your domain users (<a href=\"\/v9-0\/v9-0\/docs\/bots\/bot-admin\/security-control\/using-single-sign-on\/\" target=\"_blank\" rel=\"noopener noreferrer\">see here<\/a>),<\/li>\n<li>configure and install the Kore.ai Connector agent for Bot communications between Kore.ai and your on-premises applications using custom Kore.ai Bots (<a href=\"\/v9-0\/v9-0\/docs\/bots\/bot-admin\/security-control\/kore-ai-connector\/\" target=\"_blank\" rel=\"noopener noreferrer\">see here<\/a>),<\/li>\n<li>obtain and reset enterprise key for encryption (<a href=\"#Enterprise_Key\">see below<\/a>),<\/li>\n<li>create app and define API scopes (<a href=\"#API_Scopes\">see below<\/a>)<\/li>\n<li>other security settings (<a href=\"\/v9-0\/v9-0\/docs\/bots\/bot-admin\/security-control\/security-settings\/\" target=\"_blank\" rel=\"noopener noreferrer\">see here<\/a>)<\/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=\"key\"><span class=\"ez-toc-section\" id=\"Enterprise_Key\">Enterprise Key<\/span><\/h2>\n<p>On the <strong>Enterprise Key<\/strong> page in the <strong>Security &amp; Control<\/strong> module of the Bots Admin Console, you can view, or regenerate your enterprise data encryption key.<\/p>\n<p>By default, enterprise data, including user data, is automatically encrypted using this key when stored on Kore.ai servers. The encryption key is reissued every 60 days, or whenever manually refreshed by an admin.<\/p>\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/21\/BAC_entkey.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-22086\" src=\"\/wp-content\/uploads\/sites\/21\/BAC_entkey.png\" alt=\"\" width=\"1366\" height=\"768\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/wp-content\/uploads\/sites\/21\/20221201102805\/BAC_entkey.png 1366w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/wp-content\/uploads\/sites\/21\/20221201102805\/BAC_entkey-300x169.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/wp-content\/uploads\/sites\/21\/20221201102805\/BAC_entkey-1024x576.png 1024w\" sizes=\"auto, (max-width: 1366px) 100vw, 1366px\" \/><\/a><\/p>\n<p>To generate a new enterprise data encryption key, click <strong>Refresh<\/strong>.<\/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=\"key\"><span class=\"ez-toc-section\" id=\"API_Scopes\">API Scopes<\/span><\/h2>\n<p>Using this option you can define apps and associate API scopes for accessing various platform features.<\/p>\n<ol>\n<li>Use the\u00a0<strong>New<\/strong> button to create a new app.<\/li>\n<li>Select\u00a0<strong>+Create App<\/strong> option from App drop-down.<\/li>\n<li>Once you enter a name, a\u00a0<strong>Client ID<\/strong> and\u00a0<strong>Client Secret<\/strong> would be generated which can be used to access the platform<\/li>\n<li>For each app created the following API Scopes can be assigned as per requirement\n<ul>\n<li><strong>IntentIdentification<\/strong> includes the scopes for Intent and Entity Detection;<\/li>\n<li><strong>Bot Definition<\/strong> includes the scopes for Bot Import, Export and Creation;<\/li>\n<li><strong>Bot Publish<\/strong> for Publish access;<\/li>\n<li><strong>Test &amp; Train<\/strong> to include permissions to Train ML\u00a0 and FAQ, Utterances Import &amp; Export;<\/li>\n<li><strong>Logs<\/strong> to include retrieval capablity of Bot Audit and Admin Console Audit Logs;<\/li>\n<li><strong>Profile Management<\/strong> to get access to Role Management APIs and to Delete User Data;<\/li>\n<li><strong>Bot Analytics<\/strong> to be able to retrieve Chat History and Bot conversation Sessions<\/li>\n<li><strong>User Management<\/strong> scope to manage users;<\/li>\n<li><strong>Custom Reports<\/strong> scope to retrieve the data associated with custom widgets and reports;<\/li>\n<li><strong>ManageKnowledgeGraph<\/strong> scope to export and manage the complete definition of the Knowledge Graph;<\/li>\n<li><strong>Channel Management<\/strong> to create and update channels;<\/li>\n<li><strong>BotKit<\/strong> to configure the botkit and agent transfer;<\/li>\n<li><strong>Master Admin<\/strong> &#8211; assign this scope to get the list of sample bot.<\/li>\n<\/ul>\n<\/li>\n<li>Once created these apps can be used from within the Bot Builder Platform or externally to access various features by invoking the corresponding public API (<a href=\"\/v9-0\/v9-0\/docs\/bots\/api-guide\/api-list\/\" target=\"_blank\" rel=\"noopener noreferrer\">see here for list<\/a>).<\/li>\n<\/ol>\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":"In the Security &amp; Control\u00a0module of the Kore.ai Bots Admin Console, configure Single Sign-On (SSO) authentication for your domain users (see here), configure and install the Kore.ai Connector agent for Bot communications between Kore.ai and your on-premises applications using custom Kore.ai Bots (see here), obtain and reset enterprise key for encryption (see below), create app...","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[37],"tags":[],"class_list":["post-17855","post","type-post","status-publish","format-standard","hentry","category-security-control"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/posts\/17855","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/comments?post=17855"}],"version-history":[{"count":22,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/posts\/17855\/revisions"}],"predecessor-version":[{"id":31839,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/posts\/17855\/revisions\/31839"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/media?parent=17855"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/categories?post=17855"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/tags?post=17855"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}