18.bot-authentication

Bot Authentication

Bot Framework v4 bot authentication sample

This bot has been created using Bot Framework, it shows how to use authentication in your bot using OAuth.

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.

NOTE: Microsoft Teams currently differs slightly in the way auth is integrated with the bot. Refer to sample 5 here.

Prerequisites

• .NET SDK version 6.0

  # determine dotnet version
  dotnet --version

To try this sample

• Clone the repository

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

• Deploy your bot to Azure, see Deploy your bot to Azure

• Add Authentication to your bot via Azure Bot Service

After Authentication has been configured via Azure Bot Service, you can test the bot.

• Update appsettings.json with required configuration settings

  Property	Value Description
  MicrosoftAppId	Set the value of your Azure bot's app ID.
  MicrosoftAppPassword	Set the Azure Active Directory app client secret value.
  ConnectionName	Set the configured bot's OAuth connection name.

• Run the bot from a terminal or from Visual Studio:

  A) From a terminal, navigate to samples/csharp_dotnetcore/18.bot-authentication

  # run the bot
  dotnet run

  B) Or from Visual Studio

  • Launch Visual Studio
  • File -> Open -> Project/Solution
  • Navigate to samples/csharp_dotnetcore/18.bot-authentication folder
  • Select AuthenticationBot.csproj file
  • Press F5 to run the project

Testing the bot using Bot Framework Emulator

Bot Framework Emulator is a desktop application that allows bot developers to test and debug their bots on localhost or running remotely through a tunnel.

• Install the latest Bot Framework Emulator from here

Connect to the bot using Bot Framework Emulator

• Launch Bot Framework Emulator
• File -> Open Bot
• Enter a Bot URL of http://localhost:3978/api/messages

Interacting with the bot

This sample uses 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. These updates also take steps towards an improved user experience by eliminating the magic code verification for some clients.

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

• Bot Framework Documentation
• Bot Basics
• Azure Portal
• Add Authentication to Your Bot Via Azure Bot Service
• Activity processing
• Azure Bot Service Introduction
• Azure Bot Service Documentation
• .NET Core CLI tools
• Azure CLI
• Azure Portal
• Language Understanding using LUIS
• Channels and Bot Connector Service