Skip to content

nodejs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

nodejs

README.md

page_type sample
description This sample demonstrates how to authenticate users in a Microsoft Teams bot using Auth0 login and retrieve their profile details.
products
office-teams
office
office-365
languages
nodejs
extensions
contentType createdDate
samples
08-05-2025 20:15:25
urlFragment officedev-microsoft-teams-samples-bot-auth0-adaptivecard-nodejs

Auth0 Bot

This sample demonstrates how to authenticate users in a Microsoft Teams bot using Auth0 login and retrieve their profile details. After authentication, the bot displays the user's name, email, and profile picture in an Adaptive Card

Included Features

  • Bots
  • Adaptive Cards
  • Auth0 authentication

Interaction with bot

Conversation Bot

Try it yourself - experience the App in your Microsoft Teams client

Please find below demo manifest which is deployed on Microsoft Azure and you can try it yourself by uploading the app package (.zip file link below) to your teams and/or as a personal app. (Sideloading must be enabled for your tenant, see steps here).

Auth0 Bot: Manifest

Prerequisites

Run the app (Using Microsoft 365 Agents Toolkit for Visual Studio Code)

The simplest way to run this sample in Teams is to use Microsoft 365 Agents Toolkit for Visual Studio Code.

  1. Ensure you have downloaded and installed Visual Studio Code
  2. Install the Microsoft 365 Agents Toolkit extension
  3. Select File > Open Folder in VS Code and choose this samples directory from the repo
  4. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
  5. Select Debug > Start Debugging or F5 to run the app in a Teams web client.
  6. In the browser that launches, select the Add button to install the app to Teams.

If you do not have permission to upload custom apps (uploading), Microsoft 365 Agents Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams.

Run the app (Manually Uploading to Teams)

Note these instructions are for running the sample on your local machine, the tunnelling solution is required because the Teams service needs to call into the bot.

  1. Run ngrok - point to port 3978

    ngrok http 3978 --host-header="localhost:3978"

    Alternatively, you can also use the dev tunnels. Please follow Create and host a dev tunnel and host the tunnel with anonymous user access command as shown below:

    devtunnel host -p 3978 --allow-anonymous

  2. Register a new application in the Microsoft Entra ID – App Registrations portal.

A) Select New Registration and on the register an application page, set following values: * Set name to your app name. * Choose the supported account types (any account type will work) * Leave Redirect URI empty. * Choose Register. B) On the overview page, copy and save the Application (client) ID, Directory (tenant) ID. You'll need those later when updating your Teams application manifest and in the appsettings.json. C) Navigate to API Permissions, and make sure to add the following permissions: Select Add a permission * Select Add a permission * Select Microsoft Graph -> Delegated permissions. * User.Read (enabled by default) * Click on Add permissions. Please make sure to grant the admin consent for the required permissions.

Setup for bot

In Azure portal, create a Azure Bot resource. - For bot handle, make up a name. - Select "Use existing app registration" (Create the app registration in Microsoft Entra ID beforehand.) - If you don't have an Azure account create an Azure free account here

In the new Azure Bot resource in the Portal, - Ensure that you've enabled the Teams Channel - In Settings/Configuration/Messaging endpoint, enter the current https URL you were given by running the tunneling application. Append with the path /api/messages

Setup Auth0 Application

Create an Auth0 Application: - Go to Auth0 Dashboard. - Navigate to Applications > Applications, then click Create Application. - Choose Regular Web Applications and give it a name (e.g., Teams Bot App)

Configure Application Settings: - Under Settings, set the following:

**Allowed Callback URLs:**

```bash
Allowed Callback URLs:https://<your-domain>/api/auth/callback
```
Replace <your-domain> with your bot's public URL (e.g., dev tunnel or Azure URL).

**Get Your Auth0 Credentials:**
- Copy the Domain, Client ID, and Client Secret from the application settings.
- Add them to your project configuration (appsettings.json or IConfiguration).

Setup for code

  1. Clone the repository

    git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git

  2. In a terminal, navigate to samples/bot-auth0-adaptivecard/nodejs

  3. Install modules

    npm install

  4. Update the .env configuration for the bot to use the Microsoft App Id and App Password from the Bot Framework registration. (Note the App Password is referred to as the "client secret" in the azure portal and you can always create a new client secret anytime.) MicrosoftAppTenantId will be the id for the tenant where application is registered.

  • Also, set MicrosoftAppType in the .env. (Allowed values are: MultiTenant(default), SingleTenant, UserAssignedMSI)
  • In addition, add your Auth0 configuration details: AUTH0_CLIENT_ID: Found in your Auth0 application settings. AUTH0_CLIENT_SECRET: Found in your Auth0 application settings. AUTH0_DOMAIN: Your Auth0 domain (e.g., your-tenant.auth0.com)

  1. Run your bot at the command line:

    npm start

  2. This step is specific to Teams.

    • Edit the manifest.json contained in the appManifest folder to replace your Microsoft App Id (that was created when you registered your bot earlier) everywhere you see the place holder string <<YOUR-MICROSOFT-APP-ID>> (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)
    • Edit the manifest.json for validDomains with base Url domain. E.g. if you are using ngrok it would be https://1234.ngrok-free.app then your domain-name will be 1234.ngrok-free.app and if you are using dev tunnels then your domain will be like: 12345.devtunnels.ms.
    • Zip up the contents of the appManifest folder to create a manifest.zip (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
    • Upload the manifest.zip to Teams (In Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.)
    • Add the app to personal/team/groupChat scope (Supported scopes)

Running the sample

You can interact with this bot in Teams by sending it a message. The bot will respond to the following strings.

Show Login card: Login-card

Show Profile card: profile-card

Show Logout card: logout-card

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