page_type | languages | products | name | urlFragment | description | extensions | |||||
---|---|---|---|---|---|---|---|---|---|---|---|
sample |
|
|
Bot App with SSO Enabled |
officedev-teamsfx-samples-bot-bot-sso |
A Hello World app of Microsoft Teams Bot app with SSO |
|
A bot, chatbot, or conversational bot is an app that responds to simple commands sent in chat and replies in meaningful ways. Examples of bots in everyday use include: bots that notify about build failures, bots that provide information about the weather or bus schedules, or provide travel information. A bot interaction can be a quick question and answer, or it can be a complex conversation. Being a cloud application, a bot can provide valuable and secure access to cloud services and corporate resources.
This is a sample chatbot application demonstrating Single Sign-on using Microsoft 365 Agents SDK
and Teams Framework that can respond to a show
message.
- Use Microsoft 365 Agents Toolkit to create a Teams bot app.
- Use Microsoft Graph to get User info and picture in Teams app.
- Implementing SSO for Teams bot.
- Node.js, supported versions: 18, 20, 22
- A Microsoft 365 tenant in which you have permission to upload Teams apps. You can get a free Microsoft 365 developer tenant by joining the Microsoft 365 developer program.
- Microsoft 365 Agents Toolkit Visual Studio Code Extension version 5.0.0 and higher or Microsoft 365 Agents Toolkit CLI
Note: If you are using node 20, you can add following snippet in package.json to remove the warning of incompatibility. (Related discussion: microsoft/botbuilder-js#4550)
"overrides": {
"@azure/msal-node": "^2.6.0"
}
- From VS Code:
- hit
F5
to start debugging. Alternatively open theRun and Debug Activity
Panel and selectDebug in Teams (Edge)
orDebug in Teams (Chrome)
.
- hit
- From Microsoft 365 Agents Toolkit CLI:
- Install dev tunnel cli.
- Login with your M365 Account using the command
devtunnel user login
. - Start your local tunnel service by running the command
devtunnel host -p 3978 --protocol http --allow-anonymous
. - In the
env/.env.local
file, fill in the values forBOT_DOMAIN
andBOT_ENDPOINT
with your dev tunnel URL.BOT_DOMAIN=sample-id-3978.devtunnels.ms BOT_ENDPOINT=https://sample-id-3978.devtunnels.ms
- Run command:
atk provision --env local
. - Run command:
atk deploy --env local
. - Run command:
atk preview --env local
.
- From VS Code:
- Sign into Azure by clicking the
Sign in to Azure
under theACCOUNTS
section from sidebar. - Click
Provision
fromLIFECYCLE
section or open the command palette and select:Microsoft 365 Agents: Provision
. - Click
Deploy
or open the command palette and select:Microsoft 365 Agents: Deploy
.
- Sign into Azure by clicking the
- From Microsoft 365 Agents Toolkit CLI:
- Run command:
atk auth login azure
. - Run command:
atk provision --env dev
. - Run command:
atk deploy --env dev
.
- Run command:
- From VS Code:
- Open the
Run and Debug Activity
Panel. SelectLaunch Remote (Edge)
orLaunch Remote (Chrome)
from the launch configuration drop-down.
- Open the
- From Microsoft 365 Agents Toolkit CLI:
- Run command:
atk preview --env dev
.
- Run command:
Date | Author | Comments |
---|---|---|
Apr 19, 2022 | IvanJobs | update to support Teams Toolkit v4.0.0 |
Dec 7, 2022 | yukun-dong | update to support Teams Toolkit v5.0.0 |
Feb 22, 2024 | yukun-dong | update card to adaptive card |
May 28, 2025 | nliu | update sdk |
We really appreciate your feedback! If you encounter any issue or error, please report issues to us following the Supporting Guide. Meanwhile you can make recording of your journey with our product, they really make the product better. Thank you!