Chatbot Overview
Conversational Bots
Intents & Entities
Intelligent Bots's Approach Conversational Platform
Bot Concepts and Terminology
Natural Language Processing (NLP)
Bot Types
Bot Tasks
Starting with Platform
How to Access Bot Builder
Working with 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
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
Machine Learning
ML Model
Fundamental Meaning
Knowledge Graph Training
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
Conversation Flows
Bot Metrics
Advanced Topics
Bot Authorization
Language Management
Collaborative Development
IVR Integration
Universal Bots
Enabling Languages
Smart Bots
Sample Bots
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
SDK Overview
SDK Configuration
SDK Security
SDK App Registration 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
Inviting Users
Sending Bulk Invites to Enroll Users
Importing Users and User Data
Synchronizing Users from Active Directory
Security & Compliance
Using Single Sign-On
Cloud Connector
Bot Store
Creating a Bot Account
Adding a Bot
Choosing a Channel for a Bot
Interacting with a Bot
Setting Up Web Service Alerts
Setting Up RSS Alerts
Setting Up the Webhook Bot
Custom Bots
Bots for your Customers FAQs
Bots for your Workforce FAQs
Adding Bots
Contacting Support
Setting Up Filters
Bot Store Settings
  1. Home
  2. Docs
  3. Bots
  4. Advanced Topics
  5. Authorization
  6. Setting Up Authorization using an API Key

Setting Up Authorization using an API Key

An API key can act as both a unique identifier and a secret token for identification as well as authentication to provide a set of access rights on the associated API. Instead of prompting the end-user for both a username and password for access, the user is prompted only for an API key when configuring the Bot.
To use the API Key Authorization Type, you must first register an account with the web application and then generate an API Key for that application to configure the settings for the authorization mechanism.
The following illustration shows the fields to define for the API Key Authorization Type.
Authorization Tab - API Key DialogTo define an API key authorization, select API Key in the Authorization Type field. Then specify a Name for the authorization to be displayed in the Bot builder user interface.

Defining Tenancy

If required, in the Subdomain section, select Yes if the base URL for a web application or user interface the uses a tenant name in the URL. For example, kore is the tenant organization for a web service using tenants as

Adding Authorization Fields

By default, authorization fields are configured as part of the header of the Bot request message. If your Bot request requires additional authorization fields or the expected authorization is not part of the header, for example, social security number or PIN, click Add in the Authorization Fields section and then define the fields as shown in the following illustration.
Adding an Auth Field for Basic Auth
In the Field Type field, you can select one of the following depending on where in the Bot request message and the type of authorization fields that are required.

  • Header – The Bot expects the authorization fields as part of the header of the request.
  • Payload – The Bot expects the authorization fields as part of the content of the body of the request.
  • Query String – The Bot expects the authorization fields as a query in the body of the request.
  • Path Param – The Bot expects the authorization fields as part of the URL path for the request.

In the Field Key field, enter the name of the field for the selected Field Type.
In the Field Value field, enter the value for the Field Key specified.
Click Add. The new authorization field is added in the Authorization Fields section.
To add additional authorization fields, click Add in the Authorization Fields section.

Adding IDP Form Fields to the Authorization Form

If the default username and password fields do not meet your needs, you can add new fields displayed to the end-user by adding authorization IDP form fields. To add fields on the authorization form, click Add in the IDP Form Fields section.

The following table describes the fields used to define an authorization IDP form field.

Title of Field Specify the name of the field displayed to the end-user in the authentication dialog.
Field Key The value represents the end-user input value to the authenticating service.
Help Hint The help text displayed in the field to describe what should be entered into the field.
Field Type When Advanced Options is selected, specify the type of field displayed in the end-user interface to collect the user input assigned as the value for the Field Key, one of:

  • Textbox
  • Password
Mandatory When Advanced Options is selected, select if the end-user must define this field to complete authentication.
Data Type When Advanced Options is selected, specify the type of data expected as input from the end-user, for example, String.
Visibility When Advanced Options is selected, specify if the authentication field should be visible, hidden, or displayed as read-only.

In the Authorization Check URL field, optionally define a URL that can be used to test the authentication settings from Bot Builder before you deploy the Bot with the authorization mechanism. You can use dynamic fields, path parameter fields, query fields, and so forth, to define the test URL, for example,{{authfield1}}/?$format=json

In the Access Using a Connector section, select Yes to enable access for Bots using the Connector agent. If your domain does not have any active Connectors defined, a warning message is displayed to contact the Bots Admin Console system, administrator. For more information, see Using the Connector in the Bots Admin Console documentation.

Click Save to save the authorization settings and close the New Authorization Mechanism dialog.

Testing the Authorization – API Key

After you save the authentication, if you defined an Authorization Check URL for your new authorization type, you can test your authorization definition on the Authentication tab when you click Test Authorization before continuing to develop the remain steps of your Bot.
Authorization Tab
When you click Test Authorization, the Test Authorization dialog is displayed and populated with the URL you specified in the Authorization Check URL section, as shown in the following illustration.
Test Authorization - API Key
To configure the Test Authorization – API Key

  1. In the Auth Check URL field, verify or enter the URL to test the authentication configuration.
  2. If your bot uses subdomains, the Tenancy field is displayed and you must specify the tenant.
  3. Enter the API key for the application in the API Key field.
  4. Select the content type expected for the URL in the Content-Type field.
  5. For testing the URL, the Method field is read-only and set to GET.
  6. Click Test to begin the authorization test.

When the validation of authentication is complete, the Test Authorization dialog is closed and the results of the validation, either success or failure, is displayed to the immediate right of the Test Authorization button. If the authorization fails, the Auth Test Failed message is displayed along with the Headers and Response tabs as shown in the following illustration.
Test Authorization Failure Dialog