Microsoft Graph Toolkit Microsoft Teams Msal2 Provider

⚠️⚠️⚠️ This package is no longer receiving new features and will only receive critical bug and security fixes. All new applications should use @microsoft/mgt-teamsfx-provider instead. ⚠️⚠️⚠️

The @microsoft/mgt-teams-msal2-provider package exposes the TeamsMsal2Provider class to be used inside your Microsoft Teams tab applications to authenticate users, to call Microsoft Graph, and to power the Microsoft Graph Toolkit components. The provider is built on top of msal-browser and supports both the interactive sign in flow on the client and Single Sign-On (SSO) flow via your own backend. SSO mode is enabled by setting ssoUrl \ sso-url and requires a backend service to handle the on-behalf-of flow.

See the full documentation of the TeamsMsal2Provider

The Microsoft Graph Toolkit (mgt) library is a collection of authentication providers and UI components powered by Microsoft Graph.

Usage

The TeamsMsal2Provider requires the usage of the Microsoft Teams SDK which is not automatically installed.

1. Install the packages

   npm install @microsoft/teams-js @microsoft/mgt-element @microsoft/mgt-teams-msal2-provider
   

2. Before initializing the provider, create a new page in your application (ex: https://mydomain.com/auth) that will handle the auth redirect. Call the handleAuth function to handle all client side auth or permission consent.

   import * as MicrosoftTeams from "@microsoft/teams-js/dist/MicrosoftTeams";
   import {TeamsMsal2Provider} from '@microsoft/mgt-teams-msal2-provider';
   
   TeamsMsal2Provider.microsoftTeamsLib = MicrosoftTeams;
   TeamsMsal2Provider.handleAuth();
   

3. Initialize the provider in your main code (not on your auth page). The provider can be used in "client side auth" mode or SSO mode. SSO mode is enabled by setting ssoUrl \ sso-url and requires a backend service to handle the on-behalf-of flow.

   import {Providers} from '@microsoft/mgt-element';
   import {TeamsMsal2Provider} from '@microsoft/mgt-teams-msal2-provider';
   import * as MicrosoftTeams from "@microsoft/teams-js/dist/MicrosoftTeams";
   
   TeamsMsal2Provider.microsoftTeamsLib = MicrosoftTeams;
   
   Providers.globalProvider = new TeamsMsal2Provider({
     clientId: string;
     authPopupUrl: string; // ex: "https://mydomain.com/auth" or "/auth"
     scopes?: string[];
     msalOptions?: Configuration;
     ssoUrl?: string; // ex: '/api/token',
     autoConsent?: boolean,
     httpMethod: HttpMethod; //ex HttpMethod.POST
   })
   

4. Alternatively, initialize the provider in html (only client-id and auth-popup-url is required):