Prerequisites
Before configuring the Dialogs bot with Microsoft Teams, ensure the following prerequisites are completed:
A valid Microsoft Teams license is available.
A running Kyvos instance
Node.js (version 22.22.0) is installed on the Kyvos server for On-Premises environments. For all cloud environments (AWS, Azure, and GCP), it will be auto-configured through Kyvos Manager.
Access to Microsoft Azure and the required Azure configurations are complete as described below.
Kyvos configurations are completed as described below.
Microsoft Teams Requirement
Users must have a valid Microsoft Teams license to access and use the Dialogs bot.
Software requirements for On-Premises environments
Note
Third-party Node.js dependencies required for Dialogs bot must be downloaded from bucket and untar the files at /kyvos/dialogsbot/ folder.
A running Kyvos Server, with Node.js (version 22.22.0) installed on the node where the Dialogs Bot Server will be deployed.
To install Node.js, ensure that the user account used to install the Kyvos Bot Server has permission to run system commands and access GitHub.
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.4/install.sh | bash \. "$HOME/.nvm/nvm.sh" nvm install 22 node -v # Should print v22.22.0 npm -v # Should print 10.9.4
Microsoft Azure Configuration Requirements
Dialogs Bot integrates with Microsoft Teams through Azure Bot Resource and Microsoft Entra ID (Azure Active Directory). The configuration process involves the following steps:
Ensure that the Fully Qualified Domain Name (FQDN) is accessible at:
https://<FQDN>:3978Step 1: Registering the application in Microsoft Azure for Teams bot.
Configure an Azure Service Principal with the following credentials:
Client ID
Tenant ID
Client Secret
Step 2: Creating and configuring an Azure Bot resource
Step 3: Setting up app settings and manifest files
Step 4: Setting up the Kyvos Bot Server
For further details, see the Configuring Kyvos Dialogs Bot in Microsoft Teams section.
Kyvos Configuration
Update the REFINE_USERNAME_FOR_SSO Property
Update the
REFINE_USERNAME_FOR_SSOKyvos Property for SSO: This property determines whether the username should be refined during SSO authentication.To update this property:
Log in to Kyvos Manager.
On the navigation pane, click Kyvos and Ecosystem > Kyvos Properties.
On the page, search for the
REFINE_USERNAME_FOR_SSOproperty.Change the value to
no. The default value is Yes.
Dialogs Bot Configurations (Only for HTTPS/ Both Server)
Log in to the Web Portal terminal.
Keep the fully qualified path to the .jks file handy that was used to configure HTTPS on Kyvos.
Configure HOSTNAME in kyvos/dialogsbot/bin/start-bot.sh. Hostname must be the same as the mapped machine domain name.