6b7d0f9d71
Co-authored-by: Tracy Boehrer <trboehre@microsoft.com> |
||
---|---|---|
.. | ||
bots | ||
deploymentTemplates | ||
dialogs | ||
.env | ||
.eslintrc.js | ||
README.md | ||
index.js | ||
package.json |
README.md
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 6 here.
Prerequisites
-
Node.js version 16.16.0 or higher
# determine node version node --version
To try this sample
-
Clone the repository
git clone https://github.com/Microsoft/botbuilder-samples.git
-
In a console, navigate to
samples/javascript_nodejs/18.bot-authentication
cd samples/javascript_nodejs/18.bot-authentication
-
Install modules
npm install
-
Deploy your bot to Azure, see Deploy your bot to Azure
After Authentication has been configured via Azure Bot Service, you can test the bot.
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
- Restify
- dotenv