Skip to content

Latest commit

 

History

History
 
 

python

README.md

page_type description products languages extensions urlFragment
sample
This sample demonstrates how to create a Python-based search Messaging Extension in Microsoft Teams that includes a configuration page and supports user authentication.
office-teams
office
office-365
Python
contentType createdDate
samples
12-12-2019 13:38:25
officedev-microsoft-teams-samples-bot-msgext-search-auth-config-python

Teams Search Auth Config

This comprehensive Python sample illustrates the implementation of a search-based Messaging Extensions in Microsoft Teams, enhanced with a configuration page for user authentication and settings. By integrating Azure Active Directory for secure sign-in and utilizing the Microsoft Graph API, it enables personalized user experiences and interactions within Teams.

There are two basic types of Messaging Extension in Teams: Search-based and Action-based. This sample is built on sample 50.teams-messaging-extension-search, and illustrates how to build a Search-based Messaging Extension with a configuration page, as well as how to sign in from a search Messaging Extension.

Included Features

  • Bots
  • Message Extensions (with teams sso)
  • Search Commands

Interaction with app

msgext-search-auth-config

Try it yourself - experience the App in your Microsoft Teams client

Please find below demo manifest which is deployed on Microsoft Azure and you can try it yourself by uploading the app package (.zip file link below) to your teams and/or as a personal app. (Sideloading must be enabled for your tenant, see steps here).

Messaging Extension Auth: Manifest

Prerequisites

  • Microsoft Teams is installed and you have an account
  • Python SDK version 3.7
  • dev tunnel or ngrok latest version or equivalent tunnelling solution

Setup

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.

  1. Register a new application in the Microsoft Entra ID – App Registrations portal.

  2. Create Bot Framework registration resource in Azure

    • Use the current https URL you were given by running the tunnelling application. 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
    • Add an Microsoft Entra OAuth Connection Setting to the bot. Add authentication to your bot The name of this connection setting will be added to config.py as CONNECTION_NAME.

  3. Run ngrok - point to port 3978

    ngrok http 3978 --host-header="localhost:3978"

    Alternatively, you can also use the dev tunnels. Please follow Create and host a dev tunnel and host the tunnel with anonymous user access command as shown below:

    devtunnel host -p 3978 --allow-anonymous

  4. Clone the repository

    git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git

  • In a terminal, go to Microsoft-Teams-Samples\samples\msgext-search-auth-config\python folder

  • Update the config.py configuration for the bot to use the Microsoft App Id and App Password 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.) Also add the OAuth Connection Setting name to config.py as CONNECTION_NAME and the tunnel url as SITE_URL.

  1. Setup Manifest for Teams

  • This step is specific to Teams.

    • Edit the manifest.json contained in the ./appManifest folder to replace your Microsoft App Id (that was created when you registered your app registration earlier) everywhere you see the place holder string {{Microsoft-App-Id}} (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)
    • Edit the manifest.json for validDomains and replace {{domain-name}} with base Url of your domain. E.g. if you are using ngrok it would be https://1234.ngrok-free.app then your domain-name will be 1234.ngrok-free.app and if you are using dev tunnels then your domain will be like: 12345.devtunnels.ms.
    • Zip up the contents of the appManifest folder to create a manifest.zip (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)

  • Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")

    • Go to Microsoft Teams. From the lower left corner, select Apps
    • From the lower left corner, choose Upload a custom App
    • Go to your project directory, the ./appManifest folder, select the zip folder, and choose Open.
    • Select Add in the pop-up dialog box. Your app is uploaded to Teams.

  • Activate your desired virtual environment

  • Install dependencies by running pip install -r requirements.txt in the project folder.

  • Run your bot, either from Visual Studio or terminal with python app.py.

Note this manifest.json specified that the feature will be available from both the compose, message and commandBox areas of Teams. Please refer to Teams documentation for more details.

Running the sample

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. Right click to choose Settings and view the Config page. The default search is Pypi, and can be changed to Email from the Config page.

Adding bot UI: Add-App

Successfully-added

search

search

search

search

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