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 |
|
|
|
officedev-microsoft-teams-samples-tab-sso-csharp |
This sample application for Microsoft Teams illustrates how to implement Azure AD single sign-on (SSO) within a Teams tab using the On-Behalf-Of (OBO) flow to securely call Microsoft Graph APIs in C#. Leveraging nested app authentication, it simplifies the authentication process, enhancing user experience across Microsoft 365 environments by enabling seamless access to nested applications.
The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio.
- Install Visual Studio 2022 Version 17.10 Preview 4 or higher Visual Studio
- Install Teams Toolkit for Visual Studio Teams Toolkit extension
- In the debug dropdown menu of Visual Studio, select default startup project > Microsoft Teams (browser)
- In Visual Studio, right-click your TeamsApp project and Select Teams Toolkit > Prepare Teams App Dependencies
- Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps.
- Select Debug > Start Debugging or F5 to run the menu in Visual Studio.
- 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.
- Register a new application in the Microsoft Entra ID – App Registrations portal.
- 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.
- 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
files. - 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:
brk-<broker_application_id>://<your_domain>
.
-
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.
-
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 appsettings.json.
-
Setup NGROK
-
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
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
-
Run the app from a terminal or from Visual Studio, choose option A or B.
A) From a terminal, navigate to
/samples/tab-nested-auth/csharp
# run the app dotnet run
B) Or from Visual Studio
- Launch Visual Studio
- File -> Open -> Project/Solution
- Navigate to
/samples/tab-nested-auth/csharp
folder - Select
TabNestedAuth.sln
file - Press
F5
to run the project
-
Modify the
/appsettings.json
and fill in the following details:
{{ AzureAD Client Id }}
- Generated from Step 1 while doing Microsoft Entra ID app registration in Azure portal.{{ AzureAD Tenant Id }}
- Generated from Step 1, also referred to as Directory Tenant Id{{ Application ID URI }}
- Your Application ID URI. ex:https://1234.ngrok-free.app
- Setup Manifest for Teams
-
This step is specific to Teams.
- Edit the
manifest.json
contained in the ./appPackage folder to replace your Microsoft App Id (that was created when you registered your app registration earlier) everywhere you see the place holder string{{Microsoft-App-Id}}
(depending on the scenario the Microsoft App Id may occur multiple times in themanifest.json
) - Edit the
manifest.json
forvalidDomains
and replace{{domain-name}}
with base Url of your domain. E.g. if you are using ngrok it would behttps://1234.ngrok-free.app
then your domain-name will be1234.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
appPackage
folder to create amanifest.zip
(Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
- Edit the
-
Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")
- Go to Microsoft Teams. From the lower left corner, select Apps
- From the lower left corner, choose Upload a custom App
- Go to your project directory, the ./appPackage folder, select the zip folder, and choose Open.
- Select Add in the pop-up dialog box. Your app is uploaded to Teams.
You can interact with Teams Tab meeting sidepanel.
In the debug dropdown menu of Visual Studio, select default startup project > Outlook (browser)