Chatbot Overview
Conversational Bots
Intents & Entities
Intelligent Bots
Kore.ai's Approach
Kore.ai Conversational Platform
Bot Concepts and Terminology
Natural Language Processing (NLP)
Bot Types
Bot Tasks
Starting with Kore.ai Platform
How to Access Bot Builder
Working with Kore.ai Bot Builder
Building your first Bot
Getting Started with Building Bots
Using the Dialog Builder Tool
Creating a Simple Bot
Release Notes
Latest Updates
Older Releases
Bot Builder
Creating a Bot
Design
Develop
Dialog Task
Working with User Intent & Dialog Node
Working with Entity Node
Supported Entity Types
Working with Composite Entities
Supported Time Zones
Supported Colors
Supported Company Names
Working with Message & Confirmation Nodes
Working with Service Node
Implementing Custom Authentication
Enabling 2-way SSL for Service nodes
Working with Script Node
Working with Agent Transfer Node
Working with WebHook Node
Defining Connections & Transitions
Managing Dialogs
Prompt Editor
Context Object
Session and Context Variables
Action & Information Task
Working with Action Tasks
Working with Information Tasks
Establishing Flows
Alert Tasks
Working with Alert Tasks
Managing Ignore Words and Field Memory
Knowledge Tasks
Building Knowledge Graph
Importing and Exporting Bot Ontology
Knowledge Extraction
Natural Language
Overview
Machine Learning
ML Model
Fundamental Meaning
Knowledge Graph Training
Traits
Ranking and Resolver
NLP Detection
NLP Settings and Guidelines
Bot Intelligence
Dialog Management
Context Management
Amend Entity
Multi-Intent Detection
Default Conversations
Channel Enablement
Test & Debug
Talking to Bot
Utterance Testing
Batch Testing
Recording Conversations
Publishing your Bot
Analyzing your Bot
Overview
Dashboard
Conversation Flows
Bot Metrics
Advanced Topics
Bot Authorization
Language Management
Collaborative Development
IVR Integration
Universal Bots
Defining
Creating
Customizing
Enabling Languages
Smart Bots
Defining
Sample Bots
Github
Asana
Travel Planning
Flight Search
Event Based Bot Actions
Sentiment Analysis
Tone Analysis
Sentiment Management
Bot Settings
Bot Functions
General Settings
PII Settings
Customizing Error Messages
Bot Management
API Guide
API Overview
API List
SDKs
SDK Overview
SDK Configuration
SDK Security
SDK App Registration
Kore.ai Web SDK Tutorial
Message Formatting and Templates
Mobile SDK Push Notification
Using the BotKit SDK
Installing the BotKit SDK
Events for the BotKit SDK
Functions for the BotKit SDK
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
Web Socket Connect & RTM
Bot Administration
Bots Admin Console
User Management
Managing Your Users
Managing Your Groups
Role Management
Bots Management
Enrollment
Inviting Users
Sending Bulk Invites to Enroll Users
Importing Users and User Data
Synchronizing Users from Active Directory
Security & Compliance
Overview
Using Single Sign-On
Cloud Connector
Billing
Bot Store
Overview
Creating a Kore.ai Bot Account
Adding a Kore.ai Bot
Choosing a Channel for a Bot
Interacting with a Kore.ai Bot
Setting Up Web Service Alerts
Setting Up RSS Alerts
Setting Up the Kore.ai Webhook Bot
Custom Kore.ai Bots
Bots for your Customers FAQs
Bots for your Workforce FAQs
Adding Bots
Contacting Kore.ai Support
Setting Up Filters
Bot Store Settings
  1. Home
  2. Docs
  3. Bots
  4. Bot Administration
  5. Security & Compliance
  6. Using Single Sign-On

Using Single Sign-On

On the Kore.ai Single Sign-On page, in the Security & Control module of the Bots Admin Console, you can configure Single Sign-On (SSO) authentication for your Kore.ai managed users using the following:

  • OpenID Connect
  • Security Assertion Markup Language (SAML)
  • WS-Federation sign-on protocol.

With SSO, your managed users can log on once, for example, to your company account, and when accessing their Kore.ai application, the same login credentials can be used automatically by the system.
SSO enables easy access to the Kore.ai application using your existing identity provider.

For example, using the WS-Federation sign-on protocol, you can enable a user to sign on to the Kore.ai application using Microsoft® Active Directory® server credentials.

The following illustration shows the Single Sign-On page in the Bots Admin Console Security & Control module.

Bots Admin Security Module Single Sign-On Page

SSO using OpenID Connect

Complete the steps in the following procedure to configure SSO using Open ID Connect protocol in the Security & Control module of the Bots Admin Console. Kore.ai also supports WS-Federation and SAML Connect protocols.

  1. In the Security & Control module on the Single Sign On page in the Bots Admin Console, click Enable SSO.
  2. In the Select suitable Sign-On Protocol section, select OpenID Connect.
  3. In the Configure SSO for OpenID Connect section, select an identity provider, for example, Sign in with Google.
  4. Click Save.

The Identity Provider information successfully updated message is displayed at the top of the page. The following illustration shows the Single Sign On page with OpenID Connect sign-on protocol selected:
BotsAdminSSOOpenID

SSO using WS-Federation

Complete the steps in the following procedure to configure Single Sign-On (SSO) using the WS-Federation protocol in the Security & Control module of the Bots Admin Console. Kore.ai also supports Security Assertion Markup Language (SAML) and OpenID Connect protocols.

  1. In the Security & Control module on the Single Sign On page in the Bots Admin Console, click Enable SSO.
  2. In the Select suitable Sign-On Protocol section, select WS-Federation.
  3. In the Configure SSO for WS-Federation section, select an identity provider, and then define the settings for:
    1. Windows Azure®
      • Azure AD Sign-On End Point URL – The URL that Kore.ai sends sign on and sign off requests using Azure. The response for the authentication is sent to the Reply URL defined in your Azure Active Directory configuration settings.
      • Azure AD Federation Metadata Document – The URL for the federation metadata document used for authentication with Azure Active Directory.
    2. Other – Generic WS-Federation identity provider configuration. Select this option if you are not using Windows Azure.
      • AD Sign-On End Point URL – The URL that Kore.ai sends sign on and sign off requests using your WS-Federation identity provider.
      • AD Federation Metadata Document URL – The URL for the WS-Federation metadata document used for authentication with Active Directory.
      • In the administrative console for your Single Sign-On provider, you will also need to define the URLs that are used to exchange data between Kore.ai and your SSO provider. While the URL names may vary by SSO provider, you will need to define these URLs:

        • Assertion Consumer Service (ACS) URL or Callback URL as https://idp.kore.ai/authorize/callback. In addition to authentication values, you must pass the email address of the user as an LDAP attribute from Active Directory when using ADFS.
          Attributes for ADFS
          When you configure Single Sign-On using LDAP for ADFS, in addition to authentication attributes, your third-party SSO provider can send additional attributes to Kore.ai through the Assertion Consumer Service (ACS) URL or Callback URL.
          If you are using a built-in Kore.ai app for SSO, such as Windows Azure for WS-Federation protocol, or OneLogin for SAML protocol, required attributes are already configured for Kore.ai when you add the Kore.ai app to your SSO provider admin console. This topic describes the required and optional attributes when configuring SSO in the Bots Admin Console using the generic Other provider option available for either WS-Federation or SAML SSO protocols.
          The following data is an example of attribute data passed to Kore.ai in the callback URL.

          <Attribute Name="FirstName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" FriendlyName="First Name">
          <AttributeValue>Michael</AttributeValue>
          </Attribute>
          <Attribute Name="LastName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" FriendlyName="Last Name">
          <AttributeValue>Mehra</AttributeValue>
          </Attribute>
          <Attribute Name="DisplayName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" FriendlyName="Display Name">
          <AttributeValue>Michael Mehra</AttributeValue>
          </Attribute>
          <Attribute Name="EmailAddress" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" FriendlyName="Email">
          <AttributeValue>michael.mehra@acme.com</AttributeValue>
          </Attribute>

          These attributes are optional except for the EmailAddress, which is required. The Email Address attribute uses the following nameId format:

          SAML 2.0:
          NameID Format="urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
          SAML 1.1:
          NameID Format="urn:oasis:names:tc:SAML:1.1:nameid:format:emailAddress

          Mapping Attributes in ADFS

          ADFS is a service provided by Microsoft as a standard role for Windows Server that provides a web login using existing Active Directory credentials. When using SAML or WS-Federation protocols to log on with ADFS, you can pass other values in addition to the authentication values.
          The attribute values are defined as Claim Rules in the Relying Party Trust dialog in the SQL Server admin console. To edit the Claim Rules, select the Relying Party Trusts folder in ADFS Management, and then click Edit Claim Rules from the Actions sidebar. To add a new rule, click Add Rule, and then select the Send LDAP Attributes template. Enter the following mapping values:

          • SAML 2.0
            • LDAP Attribute: nameId
            • Claim Attribute: uri
          • SAML 1.1
            • LDAP Attribute: nameId
            • Claim Attribute: emailAddress

          [/expandsub2]

        • Identity URL or Sign On URL as https://idp.kore.ai
  4. Click Save.

The Identity Provider information successfully updated message is displayed at the top of the page. The following illustration shows the Single Sign On page with WS-Federation sign-on protocol selected:
BotsAdminSSOWSFederation

SSO using SAML

Security Assertion Markup Language (SAML) is a standard protocol for web browser Single Sign-On (SSO) using secure tokens. SAML completely eliminates all passwords and instead uses standard cryptography and digital signatures to pass a secure sign-in token from an identity provider to a SaaS application.

SAML provides a solution to allow your identity provider and service providers to exist separately from each other. When a user logs into a SAML enabled application, the service provider requests authorization from the appropriate identity provider. The identity provider authenticates the user’s credentials and then returns the authorization for the user to the service provider, and the user is now able to use the application.

How SAML works

SAML SSO works by transferring the user’s identity from one place (the identity provider) to another (the service provider). This is done through an exchange of digitally signed XML documents.

Consider the following scenario: A user is logged into a system that acts as an identity provider. The user wants to log in to a remote application, such as a support or accounting application (the service provider). The following happens:

  1. The user accesses the remote application using a link on an intranet, a bookmark, or similar and the application loads.
  2. The application identifies the user’s origin (by application subdomain, user IP address, or similar) and redirects the user back to the identity provider, asking for authentication. This is the authentication request.
  3. The user either has an existing active browser session with the identity provider or establishes one by logging into the identity provider.
  4. The identity provider builds the authentication response in the form of an XML-document containing the user’s username or email address, signs it using an X.509 certificate, and posts this information to the service provider.
  5. The service provider, which already knows the identity provider and has a certificate fingerprint, retrieves the authentication response and validates it using the certificate fingerprint.
  6. The identity of the user is established and the user is provided with app access.

Kore.ai Implementation

There are two ways SAML can be used within Kore.ai Bots Platform:

  • For developer authentication to access the Bot Builder,
  • For user authentication to access the Bot.

Use case 1: Bot builder authentication.

Enterprises can set up access to the Bot builder tool using the enterprise SSO. Bot developers and admins can log into bot builder using SSO done by the enterprise identity provider.

SSO flow from Kore.ai Bots platform: The following is the flow within the Kore.ai Bots platform once SSO is configured using SAML:

  1. The client makes a call to Kore app server (using the login URL) with user details to get identity provider info (SAML).
  2. Kore app server initiates a handshake request with the Kore idproxy server.
  3. Kore idproxy server initiates a request to the identity provider (SAML) with user details.
  4. On successful authentication, the identity provider (SAML) returns an assertion response to the Kore idproxy server.
  5. Upon verifying the response from the identity provider, Kore idproxy server initiates a request to the Kore app server.
  6. On successful authentication of the token from Kore idproxy server, Kore app server grants access to the user.

Refer below to configure SSO using SAML

Use case 2: End-user authentication

In this scenario, the bot chat interface is embedded on the customer portal or Mobile app that requires user authentication via SSO.  
The Bot access is automatically limited to authenticated users.  If the task requires API invocation that requires SSO based authentication the developer can follow the below steps

  • On the client, developer needs to retrieve SSO token of the logged in user and pass it to the bot using the secureCustomPayload parameter in the Bot SDK API.
  • In the dialog task, Bot developer can write custom logic to read this token and add it as API headers for secure API calls made using service node or webhook node.

The token information on the client varies depending upon the SSO provider and the payload, accordingly the developer would need to write custom logic.

Configuring SSO using SAML

Complete the following steps to configure Single Sign-On (SSO) using Security Assertion Markup Language (SAML) protocol in the Kore.ai Bots Admin Console. Kore.ai also supports WS-Federation and OpenID Connect protocols. For more information, see Using Single Sign-On.

  1. In the Security & Control module on the Single Sign On page in the Bots Admin Console, click Enable SSO.
  2. In the Select a suitable Sign-On Protocol section, select SAML.
  3. In the Configure SSO for SAML section, select an identity provider, and then define the settings for one of:
    1. Okta
      • Okta Single Sign-On URL – The SSO URL for Okta.
      • Identity Provider Issuer – The entity that provides the user identities including the ability to authenticate a user.
      • Certificate – The public certificate stored by the service provider from the identity provider used to validate a user signature.
      Okta for Kore.ai SSO

      To configure Single Sign-On in Okta for Kore.ai, you must first add the Kore.ai app to your Okta account, and then copy URLs and the security certificate from Okta into your Kore.ai account. This topic describes how to add the Kore.ai app to your Okta account, and then access the URLs and certificate needed for the Kore.ai configuration for SSO using Okta.
      To complete this procedure, you must have already selected Okta as a SAML provider on the Single Sign On page in the Bots Admin Console.
      To add the Kore.ai app to Okta

      1. Log on to Okta.
      2. On the Home page, click Admin. The Dashboard page is displayed.
      3. On the top navigation bar, click Applications. The Applications page is displayed.
      4. Click Add Application. The Add Application page is displayed.
      5. In the Search field, enter Kore.ai, and then press Enter. The Kore.ai app for Okta is displayed.
      6. Click the Kore.ai app. The Add Kore.ai page is displayed.
      7. On the Sign On tab, in the Settings section, click View Setup Instructions. The How to Configure SAML 2.0 for Kore.ai Application page is displayed.
      8. Copy the URLs in the:
        • Identity Provider Single Sign-On URL field to the Okta Single Sign-On URL field in Kore.ai.
        • Identity Provider Issuer field to the Kore.ai Identity provider issuer field
      9. In the Okta X.509 Certificate field, copy the certificate data, and then paste the data into the Kore.ai Certificate text box.

        Note: Only data after the —–BEGIN CERTIFICATE—– header and before the —–END CERTIFICATE—- footer should be copied and pasted into Kore.ai.

      10. In Kore.ai, click Save.

      The Identity Provider information successfully updated message is displayed at the top of the page. To test the configuration, log off the Kore.ai Bots Admin Console, and log on again. The Okta portal should be displayed.
      Okta Single Sign-On

    2. OneLogin – For more information, refer below, or in the OneLogin documentation, see Configuring SSO for Kore.ai.
      • SAML 2.0 Endpoint – The HTTP SSO endpoint for OneLogin, for example, https://app.onelogin.com/trust/saml2/http-post/sso/358111.
      • Issuer URL – The URL for the OneLogin issuer, for example,https://app.onelogin.com/saml/metadata/358111.
      • X.509 Certificate – The public certificate stored by the service provider from the identity provider used to validate a user signature.
      OneLogin for Kore.ai SSO

      To configure Single Sign-On in Kore.ai using OneLogin, you must first add the Kore.ai app to your OneLogin account, and then copy URLs and the security certificate from OneLogin into your Kore.ai account. This topic describes how to add the Kore.ai app to your OneLogin account, and then access the URLs and certificate needed for the Kore.ai configuration for SSO using OneLogin.
      To complete this procedure, you must have already selected OneLogin as a SAML provider on the Single Sign On page in the Bots Admin Console.
      To add the Kore.ai app to OneLogin

      1. Log on to OneLogin.
      2. On the APPS menu, click Add Apps. The Find Applications page is displayed.
      3. In the Search field, enter Kore.ai, and then press Enter. The Kore.ai app for OneLogin is displayed.
      4. Click the Kore.ai app. The Add Kore.ai page is displayed.
      5. Optionally, change the display name or the icons displayed to your users in the OneLogin portal, and then click SAVE. The Kore.ai app is added to your Company apps for OneLogin and the Kore.ai app page is displayed.
      6. On the SSO tab, in the Enable SAML2.0 section, copy the URLs in the:
        • OneLogin SAML 2.0 Endpoint (HTTP) field to the Kore.ai SAML 2.0 Endpoint field
        • OneLogin Issuer URL field to the Kore.ai Issuer URL field
      7. In the OneLogin X.509 Certificate field, click View Details. The Standard Strength Certificate (2048-bit) page is displayed.
      8. In the X.509 Certificate section, copy the certificate data, and then paste the data into the Kore.ai X.509 Certificate text box.

        Note: Only data after the —–BEGIN CERTIFICATE—–header and before the —–END CERTIFICATE—- footer should be copied and pasted into Kore.ai.

      9. In Kore.ai, click Save.

      The Identity Provider information successfully updated message is displayed at the top of the page. To test the configuration, log off the Kore.ai Bots Admin Console, and log on again. The OneLogin portal should be displayed.
      OneLogin Single Sign-On

    3. Bitium –
      • Single Sign-On URL – The HTTP SSO endpoint for Bitium, for example, https://www.bitium.com/7655.
      • Issuer URL – The URL for the OneLogin issuer, for example,https://bitium.com/7655/saml/82456/metadata.xml.
      • Certificate – The public certificate stored by the service provider from the identity provider used to validate a user signature.
      Kore.ai SSO for Bitium

      To configure Single Sign-On in Bitium for Kore.ai, you must first add the Kore.ai app to your Bitium account, and then copy URLs and the security certificate from Bitium into your Kore.ai account. This topic describes how to add the Kore.ai app to your Bitium account, and then access the URLs and certificate needed for the Kore.ai configuration for SSO using Bitium.
      To complete this procedure, you must have already selected Bitium as a SAML provider on the Single Sign On page in the Bots Admin Console.
      To add the Kore.ai app to Bitium

      1. Log on to Bitium.
      2. On the Manage < Company Name > menu, click Manage Apps, then click Add an App. The Add Apps dialog is displayed.
      3. In the Search field, enter Kore.ai, and then press Enter. The Install Kore.ai app for Bitium  dialog is displayed.
      4. On the Manage Organization menu, click Manage Apps, and then click Kore.ai.
      5. On the Single Sign-On tab, in the Select a Single Sign-On Provider section, select SAML Authentication.
      6. Copy the following URLs from Bitium into the Bots Admin Console Bitium configuration section:
        • Bitium Login URL field to the Kore.ai Single Sign-On field
        • Bitium Logout URL field to the Kore.ai Issuer URL field
      7. In the Bitium X.509 Certificate field, copy the certificate data, and then paste the data into the Bots Admin Console Certificate text box.

        Note: Only data after the —–BEGIN CERTIFICATE—– header and before the —–END CERTIFICATE—- footer should be copied and pasted into Kore.ai.

      8. In Kore.ai, click Save.

      The Identity Provider information successfully updated message is displayed at the top of the page. To test the configuration, log off the Kore.ai Bots Admin Console, and log on again. The Bitium portal should be displayed.
      Bitium Single Sign-On

    4. Other – Generic SAML identity provider configuration. Select this option if you are not using a Kore.ai built-in configuration.
      • Single Sign-On URL – The URL that Kore.ai sends sign on and sign off requests using your WS-Federation identity provider.
      • Issuer URL – The URL for the WS-Federation metadata document used for authentication with Active Directory.
      • Certificate – The public certificate stored by the service provider from the identity provider used to validate a user signature.
      • In the administrative console for your Single Sign-On provider, you will also need to define the URLs that are used to exchange data between Kore.ai and your SSO provider. While the URL names may vary by SSO provider, you will need to define these URLs:
        • Assertion Consumer Service (ACS) URL or Callback URL as https://idp.kore.ai/authorize/callback. In addition to authentication values, you must pass the email address of the user as an LDAP attribute from Active Directory when using ADFS. For more information, see Attributes for ADFS.
        • Identity URL or Sign On URL as https://idp.kore.ai
  4. Click Save.

The Identity Provider information successfully updated message is displayed at the top of the page. The following illustration shows the Single Sign On page with SAML sign-on protocol selected:
BotsAdminSecuritySSOSAMLOneLogin

Enable or Disable SSO

Depending on the security required for your company, you may need to enable or disable Single Sign-On (SSO) for your managed users accessing the Kore.ai application.

When you disable SSO or when the SSO authentication validity period expires, managed users must create and log on using their credentials. If no account specific password policies have been defined, then default Kore.ai password policies are automatically enabled for the managed users.

To enable Single Sign-On

  • In the Security & Control module, on the Single Sign On page, click Enable SSO.

Enable SSO

To disable Single Sign-On

  • In the Security & Control module, on the Single Sign On page, click Disable SSO, and then configure user password policies.

Disable SSO

Logging On Using Your Admin Password Instead of SSO

As an Bots Admin, you can enable Single Sign-On (SSO) using a third-party security system, for example, Google. If for some reason, your SSO security system fails, or you forget your SSO log on credentials for your third-party security system, you can still log on to the Kore.ai Bots Admin Console and bypass SSO.

A Bots Admin with a custom admin role can only bypass SSO and use their admin password if custom privileges are enabled for at least one module. To log on to the Kore.ai Directory Agent, the custom admin must have privileges enabled for Enrollment – Directory Sync.

Before you can enable SSO, the Bots Admin must have logged on the Bots Admin Console using the log on credentials provided when signing up. After the Bots Admin configures and enables SSO, you can still access the Bots Admin Console directly at the following URL:

https://bots.kore.ai/admin

The following log on page is displayed and using your Bots Admin password credentials, you can log on to the Bots Admin Console and bypass SSO, if enabled.
Using Your Password to Log On to the Bots Admin Console without SSO
If you cannot remember your Bots Admin password, enter your email ID, and then click the Forgot your password? link shown in the previous image. An email is sent to your Kore.ai email account with instructions on how to reset your Bots Admin password.

Logging Off of the Bots Admin Console

When you are finished with your session with the Bots Admin Console, you should log off the console and close your session to keep your bots account secure. To log off, click on your user name, and then click Logout as shown in the following illustration.
Logging out of the Bots Admin Console
If your Bots Admin Console session is idle for more than 15 minutes, your session is automatically terminated, and the next action in the session window will open the Kore.ai web client instead. To start a new session, click the Bots Admin Console entadminsettingsicon icon and log on.

Menu