Prerequisites

✅ Enterprise: AWS, Azure, GCP, and On-Premises

Before configuring the Dialogs bot integration 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.
Access to Microsoft Azure and the required Azure configurations are completed as described below in this section.
Kyvos configurations are completed as described below in this section.

Microsoft Teams Requirement

Users must have a valid Microsoft Teams license to access and use the Dialogs bot.

Software requirements

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>:3978
Step 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

Updating the kyvosbot.properties file

Update the kyvosbot.properties file to configure authentication details required for the Dialogs bot to validate user identity and communicate securely with Kyvos.
1. Download the configuration File and update the required properties
  1. Log in to Kyvos Manager.
  2. On the navigation pane, click Utilities > Manage Configuration Files.
  3. On the page, search for the file and download it. The file is located at kyvos/commons/config/
  4. Open the kyvosbot.properties file.
  5. Add the required configuration property details as described below.
  6. After updating the file, upload it again on the Manage Configuration Files page and save the changes.

Property	Description

Property

Description

AUTHORIZATION_SERVER_OPENID_METADATA_URL

Specifies the endpoint URL on the authorization server used to verify the ID token.

Note: This endpoint is obtained after registering the application in Microsoft Azure for the Teams bot.

Navigate to Microsoft Entra ID → Manage → App Registrations → Endpoints, and copy the OpenID Connect metadata document URL.

CLAIM_NAME

Specifies the claim that contains the user identity, such as preferred_username or email.

CLAIM_TYPE

Specifies the type of the claim derived from the claim name.

Possible values: username, email, or userid.

Update the REFINE_USERNAME_FOR_SSO Property

Update the REFINE_USERNAME_FOR_SSO Kyvos Property for SSO: This property determines whether the username should be refined during SSO authentication.
1. To update this property:
  1. Log in to Kyvos Manager.
  2. On the navigation pane, click Kyvos and Ecosystem > Kyvos Properties.
  3. On the page, search for the REFINE_USERNAME_FOR_SSO property.
  4. Change the value to no. The default value is Yes.