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
User Intent Node
Dialog Node
Entity Node
Supported Entity Types
Composite Entities
Supported Time Zones
Supported Colors
Supported Company Names
Form Node
Logic Node
Message Nodes
Confirmation Nodes
Service Node
Custom Authentication
2-way SSL for Service nodes
Script Node
Agent Transfer Node
WebHook Node
Grouping Nodes
Connections & Transitions
Managing Dialogs
Prompt Editor
Alert Tasks
Alert Tasks
Ignore Words and Field Memory
Digital Forms
Digital Views
Knowledge Graph
Importing and Exporting
Knowledge Extraction
Small Talk
Action & Information Task
Action Tasks
Information Tasks
Establishing Flows
Natural Language
Machine Learning
ML Model
Fundamental Meaning
NLP Settings and Guidelines
Knowledge Graph Training
Ranking and Resolver
NLP Detection
Bot Intelligence
Context Management
Session and Context Variables
Context Object
Dialog Management
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Default Conversations
Default Standard Responses
Channel Enablement
Test & Debug
Talk to Bot
Utterance Testing
Batch Testing
Record Conversations
Publishing your Bot
Analyzing your Bot
Custom Dashboard
Conversation Flows
Bot Metrics
Advanced Topics
Bot Authorization
Language Management
Collaborative Development
IVR Integration
Data Table
Universal Bots
Enabling Languages
Smart Bots
Sample Bots
Travel Planning
Flight Search
Event Based Bot Actions
koreUtil Libraries
Bot Settings
Bot Functions
General Settings
PII Settings
Customizing Error Messages
Bot Management
Bot Versioning
Using Bot Variables
API Guide
API Overview
API List
API Collection
SDK Overview
SDK Security
SDK App Registration
Web SDK Tutorial
Message Formatting and Templates
Mobile SDK Push Notification
Widget SDK Tutorial
Widget SDK – Message Formatting and Templates
Web Socket Connect & RTM
Using the BotKit SDK
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
Bot Administration
Bots Admin Console
User Management
Managing Users
Managing Groups
Managing Role
Bots Management
Inviting Users
Bulk Invites
Importing Users
Synchronizing Users from AD
Security & Compliance
Using Single Sign-On
Security Settings
Cloud Connector
How Tos
Creating a Simple Bot
Creating a Banking Bot
Transfer Funds Task
Update Balance Task
Context Switching
Using Traits
Schedule a Smart Alert
Configure Digital Forms
Add Form Data into Data Tables
Configuring Digital Views
Add Data to Data Tables
Update Data in Data Tables
Custom Dashboard
Custom Tags to filter Bot Metrics
Patterns for Intents & Entities
Build Knowledge Graph
Global Variables
Content Variables
Using Bot Functions
Configure Agent Transfer
  1. Home
  2. Docs
  3. Bots
  4. Advanced Topics
  5. Authorization
  6. Setting Up Authorization using OAuth v1

Setting Up Authorization using OAuth v1

OAuth v1 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, and desktop applications.

To use OAuth v1, you must first register an account with the web application as you will need the login credentials for that application to configure the settings for the authorization mechanism.

How OAuth v1 Works

  1. The application obtains an unauthorized request token from the web application.
  2. The application redirects the user to a login dialog at the web application.
  3. The user authorizes the request token, associating it with their account.
  4. The web application redirects the user back to the application.
  5. The application exchanges the request token for an access token.
  6. The access token allows the application to access a protected resource at the provider, on behalf of the user.


To define Authorization for your bot, follow these steps:

  1. Open the bot for which you want to configure an Authorization profile.
  2. Hover over the left-side navigation panel and from Settings -> Config Settings select Authorization Profile
  3. Click Add. The New Authorization Mechanism dialog opens.
  4. In the Authorization Type drop-down list, select oAuth v1.
  5. The following illustration is an example of the oAuth v1 authorization type fields that you must define to enable a customized authorization for your Bot.

To define oAuth v1, define the fields described in the following table.

Authorization Type Set to oAuth v1.
Callback URL The URL used by the web application or web service to redirect the end-user after end-user authorization is complete. This value,,  is provided as a read-only value by the application when you define oAuth v1 settings.
Identity Provider Name The name of the web application or web service, for example, Twitter. This field is required.
Consumer Key The value provided as the application identification to the web application. This field is required.
Consumer Secret The secret value provided by the application to establish ownership of the Consumer Key. This field is required.
Request Token Link The URL used by the application to obtain an unauthorized request token. The request token is a value used by the application to obtain authorization from the end-user to obtain an access token. For example, https://{tenant} After end-user authorization, an access token can be requested by the application. This field is required.
Access Token Link The URL used to exchange the end-user authorized request token for an access token. The access token is the value used by the application to gain access to the web application or web service on behalf of the end-user, instead of using the end-user credentials. For example, https://{tenant} This field is required.
User Authorization Link This is the URL used to obtain end-user authorization for the application to access the web application or web service using the access token. This field is required. You can use dynamic fields, path parameter fields, query fields, and so forth, to define the Authorization URL, for example,{{authfield1}}/?$format=json
For more information, see Using Session and Context Variables in Tasks.
Access Using a Connector Select Yes to enable access for Bots using the Connector agent. This option is only visible if a Connector agent is configured and enabled in your enterprise on-premises network. For more information, see Using the Connector.

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 at

In the following example configuration, the tenancy URL contains the {tenant} organization placeholder.

Adding Additional Fields

Click Add to open the Additional Fields dialog and then enter one or more key/value pairs that represent additional authorization input fields.

If the default username and password fields do not meet your needs for authorization input, you can add custom fields as key/value pairs that are displayed to the end-user by adding Additional Fields. You can use these fields, for example, if a PIN code is required in the authorization process, in addition to the Username and Password fields.

Additional Fields are added as shown in the following illustration.

Specify the following fields:

  • Field Key – The name of the custom field to specify for authorization.
  • Field Value – The value for the custom field to specify for authorization.
  • Click Add to save the Additional Field.

To add more Additional Fields, click Add in the Additional Fields section.

Adding Authorization Fields

By default, no authorization fields are configured as part of the header of the Bot request message. If your Bot request requires 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.

  1. 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.
  2. In the Field Key field, enter the name of the field for the selected Field Type.
  3. In the Field Value field, enter the value for the Field Key specified.
  4. 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.

Testing the Authorization

After you save the authorization, you can test your authorization definition on the Authorization page when you click Test before continuing to develop the remain steps of your Bot. When you click Test, the test is executed using the authorization token URLs and the Consumer Key and Consumer Token. If the tenancy was defined, the Test Authorization dialog is displayed. Click Test to begin the authorization test. When the validation of authorization 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. Test Authorization Failure Dialog