52.teams-messaging-extensions-search-auth-config

Teams Search Auth Config Bot

Bot Framework v4 sample for Teams expands the 50.teams-messaging-extensions-search sample to include a configuration page and Bot Service authentication.

This bot has been created using Bot Framework, it shows how to use a Messaging Extension configuration page, as well as how to sign in from a search Messaging Extension. In this sample we are assuming the OAuth 2 provider is Azure Active Directory v2 (AADv2) and are utilizing the Microsoft Graph API to retrieve data about the user. Check here for information about getting an AADv2 application setup for use in Azure Bot Service. The scopes used in this sample are the following:

• email
• openid
• profile
• Mail.Read
• User.Read
• User.ReadBasic.All
• Mail.Send.Shared

This sample is a Spring Boot app and uses the Azure CLI and azure-webapp Maven plugin to deploy to Azure.

Prerequisites

• Java 1.8+
• Install Maven
• An account on Azure if you want to deploy to Azure.
• Microsoft Teams is installed and you have an account
• ngrok or equivalent tunnelling solution

Description

• Teams Messaging Extension Auth Configuration [AAD Authentication] for search, action and link unfurling combined in the sample. -Add Authentication to your Bot

To try this sample

Note these instructions are for running the sample on your local machine, the tunnelling solution is required because the Teams service needs to call into the bot.

• Run ngrok - point to port 3978

  ngrok http -host-header=rewrite 3978

• Create Bot Framework registration resource in Azure

  • Use the current https URL you were given by running ngrok. Append with the path /api/messages used by this sample
  • Ensure that you've enabled the Teams Channel
  • If you don't have an Azure account you can use this Bot Framework registration

• Update the resources/application.properties configuration for the bot to use the MicrosoftAppId, MicrosfotAppPassword, ConnectionName, and SiteUrl (the ngrok https endpoints) from the Bot Framework registration. (Note the App Password is referred to as the "client secret" in the azure portal and you can always create a new client secret anytime.)

• This step is specific to Teams.

  • Edit the manifest.json contained in the teamsAppManifest folder to replace your Microsoft App Id (that was created when you registered your bot earlier) everywhere you see the place holder string <<YOUR-MICROSOFT-APP-ID>> (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)
  • Zip up the contents of the teamsAppManifest folder to create a manifest.zip
  • Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")

• From the root of this project folder:

  • Build the sample using mvn package
  • Unless done previously, install the packages in the local cache by using mvn install
  • Run it by using java -jar .\target\bot-teams-messaging-extensions-search-auth-config-sample.jar

Interacting with the bot in Teams

Once the Messaging Extension is installed, click the icon for Config Auth Search in the Compose Box's Messaging Extension menu to display the search window. Left click to choose Settings and view the Config page.

Avoiding Permission-Related Errors

You may encounter permission-related errors when sending a proactive message. This can often be mitigated by using MicrosoftAppCredentials.TrustServiceUrl(). See the documentation for more information.

Deploy the bot to Azure

To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.

Further reading

• Spring Boot
• Maven Plugin for Azure App Service
• How Microsoft Teams bots work
• Azure for Java cloud developers