GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Quick Start Guide
Accessing the Platform
Navigating the Kore.ai XO Platform
Building a Virtual Assistant
Help & Learning Resources
Release Notes
Current Version
Recent Updates
Previous Versions
Deprecations
Request a Feature
CONCEPTS
Design
Storyboard
Overview
FAQs
Conversation Designer
Overview
Dialog Tasks
Mock Scenes
Dialog Tasks
Overview
Navigate Dialog Tasks
Build Dialog Tasks
Node Types
Overview
Intent Node
Dialog Node
Dynamic Intent Node
GenAI Node
GenAI Prompt
Entity Node
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Process Node
Agent Transfer
Node Connections
Node Connections Setup
Sub-Intent Scoping
Entity Types
Entity Rules
User Prompts or Messages
Voice Call Properties
Knowledge AI
Introduction
Knowledge Graph
Introduction
Terminology
Build a Knowledge Graph
Manage FAQs
Knowledge Extraction
Import or Export Knowledge Graph
Prepare Data for Import
Importing Knowledge Graph
Exporting Knowledge Graph
Auto-Generate Knowledge Graph
Knowledge Graph Analysis
Answer from Documents
Alert Tasks
Small Talk
Digital Skills
Overview
Digital Forms
Digital Views
Introduction
Widgets
Panels
Session and Context Variables
Context Object
Intent Discovery
Train
NLP Optimization
ML Engine
Overview
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
LLM and Generative AI
Introduction
LLM Integration
Kore.ai XO GPT Module
Prompts & Requests Library
Co-Pilot Features
Dynamic Conversations Features
Intelligence
Introduction
Event Handlers
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Conversation Driven Dialog Builder
Sentinment Management
Tone Analysis
Default Standard Responses
Ignore Words & Field Memory
Test & Debug
Overview
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Conversation Testing Overview
Create a Test Suite
Test Editor
Test Case Assertion
Test Case Execution Summary
Glossary
Health and Monitoring
NLP Health
Flow Health
Integrations
Actions
Actions Overview
Asana
Configure
Templates
Azure OpenAI
Configure
Templates
BambooHR
Configure
Templates
Bitly
Configure
Templates
Confluence
Configure
Templates
DHL
Configure
Templates
Freshdesk
Configure
Templates
Freshservice
Configure
Templates
Google Maps
Configure
Templates
Here
Configure
Templates
HubSpot
Configure
Templates
JIRA
Configure
Templates
Microsoft Graph
Configure
Templates
Open AI
Configure
Templates
Salesforce
Configure
Templates
ServiceNow
Configure
Templates
Stripe
Configure
Templates
Shopify
Configure
Templates
Twilio
Configure
Templates
Zendesk
Configure
Templates
Agents
Agent Transfer Overview
Custom (BotKit)
Drift
Genesys
Intercom
NiceInContact
NiceInContact(User Hub)
Salesforce
ServiceNow
Configure Tokyo and Lower versions
Configure Utah and Higher versions
Unblu
External NLU Adapters
Overview
Dialogflow Engine
Test and Debug
Deploy
Channels
Publishing
Versioning
Analyze
Introduction
Dashboard Filters
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Custom Meta Tags
Create Custom Dashboard
Create Custom Dashboard Filters
LLM and Generative AI Logs
NLP Insights
Task Execution Logs
Conversations History
Conversation Flows
Conversation Insights
Feedback Analytics
Usage Metrics
Containment Metrics
Universal Bots
Introduction
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Store
Manage Assistant
Team Collaboration
Plan & Usage
Overview
Usage Plans
Templates
Support Plans
Invoices
Authorization
Conversation Sessions
Multilingual Virtual Assistants
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Feedback Survey
Masking PII Details
Variables
Collections
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data
Overview
Data Table
Table Views
App Definitions
Data as Service
HOW TOs
Build a Travel Planning Assistant
Travel Assistant Overview
Create a Travel Virtual Assistant
Design Conversation Skills
Create an ‘Update Booking’ Task
Create a Change Flight Task
Build a Knowledge Graph
Schedule a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Train the Assistant
Use Traits
Use Patterns
Manage Context Switching
Deploy the Assistant
Use Bot Functions
Use Content Variables
Use Global Variables
Use Web SDK
Build a Banking Assistant
Design Conversation Skills
Create a Sample Banking Assistant
Create a Transfer Funds Task
Create a Update Balance Task
Create a Knowledge Graph
Set Up a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Add Data to Data Tables
Update Data in Data Tables
Add Data from Digital Forms
Train the Assistant
Composite Entities
Use Traits
Use Patterns for Intents & Entities
Manage Context Switching
Deploy the Assistant
Configure an Agent Transfer
Use Assistant Functions
Use Content Variables
Use Global Variables
Intent Scoping using Group Node
Analyze the Assistant
Create a Custom Dashboard
Use Custom Meta Tags in Filters
Migrate External Bots
Google Dialogflow Bot
APIs & SDKs
API Reference
API Introduction
Rate Limits
API List
koreUtil Libraries
SDK Reference
SDK Introduction
Web SDK
How the Web SDK Works
SDK Security
SDK Registration
Web Socket Connect and RTM
Tutorials
Widget SDK Tutorial
Web SDK Tutorial
BotKit SDK
BotKit SDK Deployment Guide
Installing the BotKit SDK
Using the BotKit SDK
SDK Events
SDK Functions
Tutorials
BotKit - Blue Prism
BotKit - Flight Search Sample VA
BotKit - Agent Transfer
  1. Home
  2. Docs
  3. Virtual Assistants
  4. Advanced Topics
  5. Authorization
  6. Setting Up Authorization using oAuth v2 password grant

Setting Up Authorization using oAuth v2 password grant

Setting Up Authorization using oAuth v2 password grant type

OAuth v2 is the new version of the open protocol to allow secure authorization in a standardized manner from web, mobile, and desktop applications. 

To use this authorization method, you must first register an account with the web application as you will need the log-in credentials for that application to configure the settings for the Authorization Mechanism.

How oAuth v2 Password Grant Type Works

The oAuth v2 Password grant type authorization method allows apps to exchange a user’s credentials for an access token. 

  1. The XO Platform redirects the user to a login dialog at the web application.
  2. The user authenticates.
  3. The web application redirects the user back to the XO Platform with an access token.
  4. The XO Platform validates the access token.
  5. The access token allows the XO Platform to access a protected resource at the provider, on behalf of the user.

Configuring oAuth v2 Using Password Grant Type

To define Authorization for your assistant, using oAuth v2 password grant, please follow these steps:

  1. Open the assistant for which you want to configure an Authorization profile.
  2. Select the Build tab from the top menu.
  3. From the left menus, click Configurations > Authorization Profile.
  4. Click Add to open the New Authorization Mechanism dialog.

  5. In the Authorization Type drop-down list, select oAuth v2 password grant type.
  6. Enter a Name for your authorization, then define the fields to enable it.

The illustration and sections below show an overview of the needed configurations.

Defining Tenancy

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

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

Adding Form Fields

If, for example, the default username and password fields do not meet your needs for authorization input, you can add custom fields displayed to the end-user by adding authorization IDP form fields. You can use these form fields, for example, if PIN code is required in the authorization process.

To add fields on the authorization form, click Add Form Fields, then configure the necessary parameters for each field. The following table describes the fields used to define an authorization form field.

FIELD NAME

DESCRIPTION

Title of Field

Specify the name of the field displayed to the end-user in the authorization dialog.

Field Key

The value represents the end-user input value to the authorizing 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 the authorization.

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 authorization field should be visible, hidden, or displayed as read-only.

Adding Authorization Fields

By default, authorization fields are configured as part of the header of the request message. If your request requires additional authorization fields or the expected authorization is not part of the header, for example, social security number or PIN, click Add Authorization Fields 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 request message and the type of authorization fields that are required.
    1. Header – The assistant expects the authorization fields as part of the header of the request.
    2. Payload – The assistant expects the authorization fields as part of the content of the body of the request.
    3. Query String – The assistant expects the authorization fields as a query in the body of the request.
    4. Path Param – The assistant 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 Done. The new authorization field is added in the Authorization Fields section.

Defining the Token URLs

In the Token URL field, optionally define a URL that can be used to test the authorization settings from XO Platform before you deploy the VA with the authorization mechanism. You can use dynamic fields, path parameter fields, query fields, and so forth, to define the test URL, for example,

http://{tenant}.someCompany.com/test/{{tokenId}}

In the Token URL Method field, select the HTTP request method type for the Token URL. One of PUT, POST, PATCH, DELETE, and GET.

In the Token URL Content Type field, select the content type expected from the Token URL. One of: JSON, RSS, XML, URL Encoded JSON, CSV, Text, Twitter Encoded JSON, Multipart/Form-data,Multipart/Related, or Oracle ADF.

In the Refresh Token URL, enter the refresh token URL if required. 

For situations when there may be authentication errors, enter the Auth Error Status Code.

Access using the Connector

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

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

Testing the Authorization 

After you save the authorization, you can test your authorization definition when you click Test from the Authorization Profile page. 

When you click Test, the Test Authorization dialog is displayed and populated with the URL you specified in the Authorization Check URL section. 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 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.

Setting Up Authorization using oAuth v2 password grant

Setting Up Authorization using oAuth v2 password grant type

OAuth v2 is the new version of the open protocol to allow secure authorization in a standardized manner from web, mobile, and desktop applications. 

To use this authorization method, you must first register an account with the web application as you will need the log-in credentials for that application to configure the settings for the Authorization Mechanism.

How oAuth v2 Password Grant Type Works

The oAuth v2 Password grant type authorization method allows apps to exchange a user’s credentials for an access token. 

  1. The XO Platform redirects the user to a login dialog at the web application.
  2. The user authenticates.
  3. The web application redirects the user back to the XO Platform with an access token.
  4. The XO Platform validates the access token.
  5. The access token allows the XO Platform to access a protected resource at the provider, on behalf of the user.

Configuring oAuth v2 Using Password Grant Type

To define Authorization for your assistant, using oAuth v2 password grant, please follow these steps:

  1. Open the assistant for which you want to configure an Authorization profile.
  2. Select the Build tab from the top menu.
  3. From the left menus, click Configurations > Authorization Profile.
  4. Click Add to open the New Authorization Mechanism dialog.

  5. In the Authorization Type drop-down list, select oAuth v2 password grant type.
  6. Enter a Name for your authorization, then define the fields to enable it.

The illustration and sections below show an overview of the needed configurations.

Defining Tenancy

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

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

Adding Form Fields

If, for example, the default username and password fields do not meet your needs for authorization input, you can add custom fields displayed to the end-user by adding authorization IDP form fields. You can use these form fields, for example, if PIN code is required in the authorization process.

To add fields on the authorization form, click Add Form Fields, then configure the necessary parameters for each field. The following table describes the fields used to define an authorization form field.

FIELD NAME

DESCRIPTION

Title of Field

Specify the name of the field displayed to the end-user in the authorization dialog.

Field Key

The value represents the end-user input value to the authorizing 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 the authorization.

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 authorization field should be visible, hidden, or displayed as read-only.

Adding Authorization Fields

By default, authorization fields are configured as part of the header of the request message. If your request requires additional authorization fields or the expected authorization is not part of the header, for example, social security number or PIN, click Add Authorization Fields 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 request message and the type of authorization fields that are required.
    1. Header – The assistant expects the authorization fields as part of the header of the request.
    2. Payload – The assistant expects the authorization fields as part of the content of the body of the request.
    3. Query String – The assistant expects the authorization fields as a query in the body of the request.
    4. Path Param – The assistant 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 Done. The new authorization field is added in the Authorization Fields section.

Defining the Token URLs

In the Token URL field, optionally define a URL that can be used to test the authorization settings from XO Platform before you deploy the VA with the authorization mechanism. You can use dynamic fields, path parameter fields, query fields, and so forth, to define the test URL, for example,

http://{tenant}.someCompany.com/test/{{tokenId}}

In the Token URL Method field, select the HTTP request method type for the Token URL. One of PUT, POST, PATCH, DELETE, and GET.

In the Token URL Content Type field, select the content type expected from the Token URL. One of: JSON, RSS, XML, URL Encoded JSON, CSV, Text, Twitter Encoded JSON, Multipart/Form-data,Multipart/Related, or Oracle ADF.

In the Refresh Token URL, enter the refresh token URL if required. 

For situations when there may be authentication errors, enter the Auth Error Status Code.

Access using the Connector

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

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

Testing the Authorization 

After you save the authorization, you can test your authorization definition when you click Test from the Authorization Profile page. 

When you click Test, the Test Authorization dialog is displayed and populated with the URL you specified in the Authorization Check URL section. 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 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.

Menu