Authentication Bot Utilizing MS Graph

Bot Framework v4 bot authentication using Microsoft Graph sample

This bot has been created using Bot Framework, is shows how to uss the bot authentication capabilities of Azure Bot Service. 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
• Mail.Read
• Mail.Send.Shared
• openid
• profile
• User.Read
• User.ReadBasic.All

Prerequisites

• Node.js version 10.14 or higher

  # determine node version
  node --version

• Update .env with required configuration settings

  • MicrosoftAppId
  • MicrosoftAppPassword
  • ConnectionName

To try this sample

• Clone the repository

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

• In a terminal, navigate to samples/javascript_nodejs/24.bot-authentication-msgraph

  cd samples/javascript_nodejs/24.bot-authentication-msgraph

• Install modules

  npm install

• Start the bot

  npm start

Testing the bot using Bot Framework Emulator

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 from here
• In Bot Framework Emulator Settings, enable Use a sign-in verification code for OAuthCards to receive the magic code

Connect to bot using Bot Framework Emulator

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

Authentication

This sample uses the bot authentication capabilities of 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, and so on. These updates also take steps towards an improved user experience by eliminating the magic code verification for some clients and channels. It is important to note that the user's token does not need to be stored in the bot. When the bot needs to use or verify the user has a valid token at any point the OAuth prompt may be sent. If the token is not valid they will be prompted to login.

Microsoft Graph API

This sample demonstrates using Azure Active Directory v2 as the OAuth2 provider and utilizes the Microsoft Graph API. Microsoft Graph is a Microsoft developer platform that connects multiple services and devices. Initially released in 2015, the Microsoft Graph builds on Office 365 APIs and allows developers to integrate their services with Microsoft products including Windows, Office 365, and Azure.

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
• Microsoft Graph API
• MS Graph Docs and SDK
• 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