Prerequisites
Before configuring the Kyvos Dialogs bot integration with Microsoft Teams, ensure the following prerequisites are completed:
Microsoft Teams Requirement
Users must have a valid Microsoft Teams license to access and use the Kyvos Dialogs Bot.
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:
Register the Microsoft Teams bot in Microsoft Azure.
Create and configure an Azure Bot Resource.
Configure an Azure Service Principal with the following credentials:
Client ID
Tenant ID
Client Secret
Configure the required application settings and manifest files.
Ensure that the Fully Qualified Domain Name (FQDN) is accessible at:
https://<FQDN>:3978
For more details, see the Configuring Kyvos Dialogs Bot in Microsoft Teams section.
Software requirements
A running Kyvos server where you must install Node.js (version 22.22.0).
To install Node.js, do one of the following:
Download Node.js from here.
Run the following commands using the user account intended to install the Kyvos bot server.
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
Kyvos Configuration
Update the
kyvosbot.propertiesfile that is used to configure authentication details that enable the Dialogs bot to securely validate user identity and communicate with Kyvos.Download the configuration File and update the required properties
Navigate to the Manage Configuration Files page.
Search for the file and download it.
Open the
kyvosbot.propertiesfile.Add the required configuration property details as described below.
After updating the file, upload it again on the Manage Configuration Files page and save the changes.
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: |
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:
Go to the Kyvos Properties page in Kyvos Manager.
Search for the
REFINE_USERNAME_FOR_SSOproperty.Change the value to
no.