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. Docs
  2. Virtual Assistants
  3. Advanced Topics
  4. Setting Up the Kerberos SPNEGO Authorization Profile

Setting Up the Kerberos SPNEGO Authorization Profile

Overview

The XO Platform offers Kerberos SPNEGO-based authentication mechanism for enterprise users to use Kerberos authentication flow to securely connect with their internal applications using Kerberos SPNEGO security protocol.

The Kerberos-SPNEGO authentication process includes multiple steps to establish a secure connection between a client and a server using the SPNEGO negotiation mechanism and the Kerberos authentication protocol. The combination of SPNEGO and Kerberos ensures a secure and efficient authentication process to enable clients to access sensitive data securely.

The Kerberos SPNEGO auth profile can be configured from the following XO Platform settings:

Configuring Kerberos SPNEGO Authorization

Steps to configure the Authorization for your assistant with Kerberos-SPNEGO auth profile:

  1. Open the virtual assistant (VA) for which you want to configure the Authorization profile.
  2. Select the Build tab from the top menu.
  3. From the left-side vertical menus, click Configurations > Authorization Profiles.
  4. Click Add to open the New Authorization Mechanism dialog.

  5. In the Authorization Type drop-down list, select the Kerberos-SPNEGO option.

  6. In the Name field, enter a name for the authorization type.
  7. Define the required Kerberos Authorization fields. For more information, see the Defining Authorization Fields section.
  8. (optional) Click + Add Authorization Field to add additional fields for Kerberos authorization. For more information, see the Adding Authorization Fields section.
  9. Click Save Auth.

Defining Authorization Fields

To configure the Kerberos SPNEGO authorization profile, define the fields described in the following table.

FIELD NAME DESCRIPTION Required or Optional
Authorization Type Set to Kerberos SPNEGO
Name The name of the authorization profile or service, for example, Kerberos Profile Required
Service Principal URL The URL to access the Kerberos service and initiate the authentication process. Required
Authorization Check URL This is the URL used to obtain end-user authorization for the XO Platform to access the web application or web service using the access token. The XO Platform accepts a valid URL with a maximum length of 3000 characters. This field is required. You can use dynamic fields, path parameter fields, query fields, and so forth, to define the Authorization URL, for example,

     https://kore.someCompany.com/sap/opu/odata/sap/{{authfield1}}/?$format=json

or

https://{tenant}.service-now.com/api/now/v1/table/incident
For more information, see Using Session and Context Variables in Tasks.

Required
Authorization Fields The authorization fields for the token bearer. Optional
Refresh Token URL Enter a Refresh Token URL, if required, for cases when the authentication token expires and has to be refreshed. The XO Platform accepts a valid URL with a maximum length of 3000 characters. Required
Description Enter a description for your authorization. Optional
Authentication Types Bot designers can set this setting to modify the Kerberos authentication behavior.

Choose one of the following Authentication Types:

  • Mutual – By default, this option is selected. The Mutual authentication ensures that both the client and the server authenticate each other during the Kerberos SPNEGO authentication process.
  • Delegate – The delegate option is also known as delegation or credential delegation. It means the client can pass its Kerberos credentials to the service. The service can then use these credentials to authenticate to other services on behalf of the client.
Required

 

Adding Authorization Fields

Click +Add Authorization Field and then enter one or more key/value pairs that represent additional authorization input fields.

If, for example, 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.

Authorization Fields are added, as shown in the following illustration.

Specify the following fields:

  • Field Type  –  The type of the custom field. Field type can be Header, Payload, Query String, or Path Param.
  • Field Key – The name of the custom field.
  • Value – The value of the custom field.

Click Done to save the Additional Field.

Testing the Authorization

After you save the authentication, you can test your authorization definition on the Authentication page when you click Test before continuing to develop the remaining steps of your task. 

Steps to test the Kerberos Auth Profile:

  1. Click on the Test button in the Kerberos Auth Profile row to begin the authorization test.
  2. In the Test Authorization window, select the Content-Type and Method field values and click Test.
  3. 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.

Setting Up the Kerberos SPNEGO Authorization Profile

Overview

The XO Platform offers Kerberos SPNEGO-based authentication mechanism for enterprise users to use Kerberos authentication flow to securely connect with their internal applications using Kerberos SPNEGO security protocol.

The Kerberos-SPNEGO authentication process includes multiple steps to establish a secure connection between a client and a server using the SPNEGO negotiation mechanism and the Kerberos authentication protocol. The combination of SPNEGO and Kerberos ensures a secure and efficient authentication process to enable clients to access sensitive data securely.

The Kerberos SPNEGO auth profile can be configured from the following XO Platform settings:

Configuring Kerberos SPNEGO Authorization

Steps to configure the Authorization for your assistant with Kerberos-SPNEGO auth profile:

  1. Open the virtual assistant (VA) for which you want to configure the Authorization profile.
  2. Select the Build tab from the top menu.
  3. From the left-side vertical menus, click Configurations > Authorization Profiles.
  4. Click Add to open the New Authorization Mechanism dialog.

  5. In the Authorization Type drop-down list, select the Kerberos-SPNEGO option.

  6. In the Name field, enter a name for the authorization type.
  7. Define the required Kerberos Authorization fields. For more information, see the Defining Authorization Fields section.
  8. (optional) Click + Add Authorization Field to add additional fields for Kerberos authorization. For more information, see the Adding Authorization Fields section.
  9. Click Save Auth.

Defining Authorization Fields

To configure the Kerberos SPNEGO authorization profile, define the fields described in the following table.

FIELD NAME DESCRIPTION Required or Optional
Authorization Type Set to Kerberos SPNEGO
Name The name of the authorization profile or service, for example, Kerberos Profile Required
Service Principal URL The URL to access the Kerberos service and initiate the authentication process. Required
Authorization Check URL This is the URL used to obtain end-user authorization for the XO Platform to access the web application or web service using the access token. The XO Platform accepts a valid URL with a maximum length of 3000 characters. This field is required. You can use dynamic fields, path parameter fields, query fields, and so forth, to define the Authorization URL, for example,

     https://kore.someCompany.com/sap/opu/odata/sap/{{authfield1}}/?$format=json

or

https://{tenant}.service-now.com/api/now/v1/table/incident
For more information, see Using Session and Context Variables in Tasks.

Required
Authorization Fields The authorization fields for the token bearer. Optional
Refresh Token URL Enter a Refresh Token URL, if required, for cases when the authentication token expires and has to be refreshed. The XO Platform accepts a valid URL with a maximum length of 3000 characters. Required
Description Enter a description for your authorization. Optional
Authentication Types Bot designers can set this setting to modify the Kerberos authentication behavior.

Choose one of the following Authentication Types:

  • Mutual – By default, this option is selected. The Mutual authentication ensures that both the client and the server authenticate each other during the Kerberos SPNEGO authentication process.
  • Delegate – The delegate option is also known as delegation or credential delegation. It means the client can pass its Kerberos credentials to the service. The service can then use these credentials to authenticate to other services on behalf of the client.
Required

 

Adding Authorization Fields

Click +Add Authorization Field and then enter one or more key/value pairs that represent additional authorization input fields.

If, for example, 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.

Authorization Fields are added, as shown in the following illustration.

Specify the following fields:

  • Field Type  –  The type of the custom field. Field type can be Header, Payload, Query String, or Path Param.
  • Field Key – The name of the custom field.
  • Value – The value of the custom field.

Click Done to save the Additional Field.

Testing the Authorization

After you save the authentication, you can test your authorization definition on the Authentication page when you click Test before continuing to develop the remaining steps of your task. 

Steps to test the Kerberos Auth Profile:

  1. Click on the Test button in the Kerberos Auth Profile row to begin the authorization test.
  2. In the Test Authorization window, select the Content-Type and Method field values and click Test.
  3. 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.
메뉴