Skip to content

Latest commit

 

History

History
 
 

18.bot-authentication

README.md

bot authentication sample

Bot Framework v4 bot authentication sample

This bot has been created using Microsoft 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.

Prerequisites

  • Node.js version 8.5 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

  • Provision Azure Bot Service to host the bot

    Assuming prerequisites have been installed:

    # log into Azure
az login
    # set you Azure subscription
az account set --subscription "<azure-subscription>"
    # Create Azure Bot Service, deploy sample to Azure
msbot clone services --name "<your_bot_name>" --code-dir "." --location westus --sdkLanguage "Node" --folder deploymentScripts/msbotClone --verbose

  • Add Authentication to your bot via Azure Bot Service

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

There are two ways in which you can test

  • Start the bot 
    npm start

Testing the bot using Bot Framework Emulator v4

Microsoft 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 Bot Framework Emulator version 4.2.0 or greater from here

Connect to the bot using Bot Framework Emulator v4

  • Launch Bot Framework Emulator
  • File -> Open Bot Configuration
  • Navigate to samples/javascript_nodejs/18.bot-authentication folder
  • Select <your_bot_name>.bot file

Authentication

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

After creating the bot and testing it locally, you can deploy it to Azure to make it accessible from anywhere. To deploy your bot to Azure:

# login to Azure
az login

Publishing Changes to Azure Bot Service

As you make changes to your locally running bot, you can deploy those changes to Azure Bot Service using a publish helper. See publish.cmd if you are on Windows or ./publish if you are on a non-Windows platform. The following is an example of publishing local changes to Azure:

# build the TypeScript bot before you publish
npm run build
# run the publish helper (non-Windows) to update Azure Bot Service.  Use publish.cmd if running on Windows
./publish

Getting Additional Help with Deploying 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