README.md

page_type	description	products	languages	extensions	urlFragment
sample	This sample showcases Azure AD single sign-on (SSO) within a Microsoft Teams tab, utilizing the On-Behalf-Of (OBO) flow to call	office-teams office office-365	nodejs	contentType createdDate samples 07-16-2024 10:00:01	officedev-microsoft-teams-samples-tab-nested-auth-nodejs

Nested app authentication

Nested app authentication (NAA) is a new authentication protocol for single page applications embedded in host environments like Teams, Outlook, and Microsoft 365, simplifying the authentication process to facilitate single sign-on (SSO) across nested applications and offering several advantages over the On-Behalf-Of (OBO) flow.

Interaction with app

Prerequisites

• NodeJS
• dev tunnel or ngrok latest version or equivalent tunnelling solution
• VS Code
• Teams Toolkit for VS Code or TeamsFx CLI

Run the app (Using Teams Toolkit for Visual Studio Code)

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

1. Ensure you have downloaded and installed Visual Studio Code
2. Install the Teams 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 (sideloading), Teams 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.

Setup Register you app with Azure AD.

1. Register a new application in the Microsoft Entra ID – App Registrations portal.
2. 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.
3. 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 Msal.js files.
4. Navigate to Authentication If an app hasn't been granted IT admin consent, users will have to provide consent the first time they use an app.

• Set a redirect URI:

  • Select Add a platform.
  • Select Single-page application.
  • Enter the redirect URI for the app in the following format: https://{Base_Url}/tab and brk-<broker_application_id>://<your_domain>.

  

5. Navigate to API Permissions, and make sure to add the follow permissions: - 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.

6. Navigate to the Certificates & secrets. In the Client secrets section, click on "+ New client secret". Add a description(Name of the secret) for the secret and select “Never” for Expires. Click "Add". Once the client secret is created, copy its value, it need to be placed in the .env.

Setup

Note these instructions are for running the sample on your local machine.

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. Clone the repository

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

3. In a different terminal, navigate to samples/tab-nested-auth/nodejs folder, Open your local terminal and run the below command to install node modules. You can do the same in Visual studio code terminal by opening the project in Visual studio code

   npm install

   npm start

• The client will start running on 3978 port

4. Open Msal.js file from this path folder samples/tab-nested-auth/nodejs/src/components and update:
   • {{clientId}} - Generated from Step 1 (Application (client) ID)is the application app id

This step is specific to Teams:

• Edit the manifest.json contained in the AppManifest folder to replace your Microsoft App Id <<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 {{domain-name}} 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 static tabs.

Running the sample

You can interact with Teams Tab meeting sidepanel.

Install app:

Click Login:

Outlook on the web

To debug the app

1. Open the folder in Visual Studio Code with Teams Toolkit extension installed.
2. Open Debug View (Ctrl+Shift+D) and select "Debug in Outlook (Edge)" in dropdown list.
3. Press "F5" to debug the app in the Outlook app in a browser window.

Running the sample

Click Login:

Login Details:

Further reading

• Nested app authentication

• SPA Redirect URL