Have ideas to improve npm?Join in the discussion! »

@microsoft/mgt-teams-providerTypeScript icon, indicating that this package has built-in type declarations

2.0.1 • Public • Published

Microsoft Graph Toolkit Microsoft Teams Provider

npm

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

The @microsoft/mgt-teams-provider package exposes the TeamsProvider class to be used inside your Microsoft Teams tab applications to authenticate users, to call Microsoft Graph, and to power the mgt components.

See docs for full documentation of the TeamsProvider

Usage

The TeamsProvider 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-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 authentication on your behalf.

    import * as MicrosoftTeams from "@microsoft/teams-js/dist/MicrosoftTeams";
    import {TeamsProvider} from '@microsoft/mgt-teams-provider';
    
    TeamsProvider.microsoftTeamsLib = MicrosoftTeams;
    TeamsProvider.handleAuth();
  3. Initialize the provider in your main code (not on your auth page)

    import {Providers} from '@microsoft/mgt-element';
    import {TeamsProvider} from '@microsoft/mgt-teams-provider';
    import * as MicrosoftTeams from "@microsoft/teams-js/dist/MicrosoftTeams";
    
    TeamsProvider.microsoftTeamsLib = MicrosoftTeams;
    
    Providers.globalProvider = new TeamsProvider({
      clientId: string;
      authPopupUrl: string; // ex: "https://mydomain.com/auth" or "/auth"
      scopes?: string[];
      msalOptions?: Configuration;
    })
  4. Alternatively, initialize the provider in html (only client-id and auth-popup-url is required):

    <script type="module" src="../node_modules/@microsoft/mgt-teams-provider/dist/es6/index.js" />
    
    <mgt-teams-provider client-id="<YOUR_CLIENT_ID>"
                        auth-popup-url="/AUTH-PATH"
                        scopes="user.read,people.read..." 
                        authority=""></mgt-teams-provider>

See provider usage documentation to learn about how to use the providers with the mgt components, to sign in/sign out, get access tokens, call Microsoft Graph, and more.

Sea also

Install

npm i @microsoft/mgt-teams-provider

DownloadsWeekly Downloads

416

Version

2.0.1

License

MIT

Unpacked Size

484 kB

Total Files

18

Last publish

Collaborators

  • avatar
  • avatar