Skip to content

Latest commit

 

History

History
 
 

csharp

README.md

page_type description products languages extensions urlFragment
sample
This sample app demonstrate how to use authentication in search based Messaging Extension
office-teams
office
office-365
csharp
contentType createdDate
samples
10/17/2019 13:38:25 PM
officedev-microsoft-teams-samples-msgext-search-auth-config-csharp

Teams Search Auth Config

Bot Framework v4 sample for Teams expands the msgext-search-auth-config 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

Included Features

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

Interaction With Messaging Extension Auth

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
  • .NET SDK version 6.0
  • 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

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. Setup for Messaging Extension Auth

Refer to Bot SSO Setup document.

  1. Clone the repository

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

  2. If you are using Visual Studio

    • Launch Visual Studio
    • File -> Open -> Project/Solution
    • Navigate to samples/msgext-search-auth-config/csharp folder
    • Select TeamsMessagingExtensionsSearchAuthConfig.csproj or TeamsMessagingExtensionsSearchAuthConfig.slnfile

  3. Run ngrok - point to port 3978 (You can skip this step, if you have already run ngrok while doing SSO setup)

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

  4. Update the appsettings.json configuration for the bot to use the MicrosoftAppId, MicrosoftAppPassword, MicrosoftAppTenantId generated in Step 1 (App Registration creation). (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.)

    • Set "MicrosoftAppType" in the appsettings.json. (Allowed values are: MultiTenant(default), SingleTenant, UserAssignedMSI)
    • Set "ConnectionName" in the appsettings.json. The AAD ConnectionName from the OAuth Connection Settings on Azure Bot registration
    • Set "SiteUrl" in the appsettings.json. The ngrok forwarding url (ie https://xxxx.ngrok-free.app) from starting ngrok

  5. Run your bot, either from Visual Studio with F5 or using dotnet run in the appropriate folder.

  6. 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 MicrosoftAppId may occur multiple times in the manifest.json)
    • Edit the manifest.json for validDomains with base Url 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.
    • Zip up the contents of the TeamsAppManifest 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 Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.)

Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.

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. Left click to choose Settings and view the Sign-In page.

Adding bot UI:

Zero install link unfurling card

zero install

3-ME-Open

4-ME-Search-Config

5-ME-Login-Page

6-ME-LoggedIn

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