Skip to content

Latest commit

 

History

History
 
 

46.teams-auth

README.md

Teams Auth Bot

Bot Framework v4 bot using Teams authentication

This bot has been created using Bot Framework, it shows how to get started with authentication in a bot for Microsoft Teams.

The focus of this sample is how to use the Bot Framework support for oauth in your bot. Teams behaves slightly differently than other channels in this regard. Specifically an Invoke Activity is sent to the bot rather than the Event Activity used by other channels. This Invoke Activity must be forwarded to the dialog if the OAuthPrompt is being used. This is done by subclassing the ActivityHandler and this sample includes a reusable TeamsActivityHandler. This class is a candidate for future inclusion in the Bot Framework SDK.

The sample uses the bot authentication capabilities in Azure Bot Service, providing features to make it easier to develop a bot that authenticates users to various identity providers such as Azure AD (Azure Active Directory), GitHub, Uber, etc. The OAuth token is then used to make basic Microsoft Graph queries.

IMPORTANT: The manifest file in this app adds "token.botframework.com" to the list of validDomains. This must be included in any bot that uses the Bot Framework OAuth flow.

Single Sign On

This sample utilizes an app setting UseSingleSignOn to add TeamsSSOTokenExchangeMiddleware. Refer to Teams SSO for AAD and SSO OAuth configuration information.

IMPORTANT: Teams SSO only works in 1-1 chats, and not group contexts.

Prerequisites

  • Microsoft Teams is installed and you have an account (not a guest account)

  • .NET Core SDK version 3.1

    # determine dotnet version
dotnet --version

  • ngrok or equivalent tunnelling solution

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.

  1. Clone the repository

    git clone https://github.com/Microsoft/botbuilder-samples.git

  2. If you are using Visual Studio

  • Launch Visual Studio
  • File -> Open -> Project/Solution
  • Navigate to samples/csharp_dotnetcore/46.teams-auth folder
  • Select TeamsAuth.csproj file

  1. Run ngrok - point to port 3978

    ngrok http -host-header=rewrite 3978

  2. Create Bot Framework registration resource in Azure

  3. Update the appsettings.json 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.)

  4. 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")

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

Interacting with the bot in Teams

Note manifest.json specifies the bot will be installed in a "personal" scope only. Please refer to Teams documentation for more details. sso_manifest.json contains a webApplicationInfo template required for Teams Single Sign On.

You can interact with this bot by sending it a message. The bot will respond by requesting you to login to AAD, then making a call to the Graph API on your behalf and returning the results.

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