JSPM

@microsoft/mgt-msal2-provider

2.3.1-preview.d30ed97
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 8187
  • Score
    100M100P100Q154345F
  • License MIT

The Microsoft Graph Toolkit Msal 2.0 Provider

Package Exports

  • @microsoft/mgt-msal2-provider

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@microsoft/mgt-msal2-provider) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Microsoft Graph Toolkit MSAL 2.0 Provider

npm

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

The @microsoft/mgt-msal2-provider package exposes the Msal2Provider class which uses msal-browser to sign in users and acquire tokens to use with Microsoft Graph.

Usage

  1. Install the packages

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

  2. Initialize the provider in code with Msal2Config

    import {Providers, LoginType} from '@microsoft/mgt-element';
import {Msal2Provider, PromptType} from '@microsoft/mgt-msal2-provider';

// initialize the auth provider globally
Providers.globalProvider = new Msal2Provider({
  clientId: 'clientId',
  scopes?: string[],
  authority?: string,
  redirectUri?: string,
  loginType?: LoginType, // LoginType.Popup or LoginType.Redirect (redirect is default)
  prompt?: PromptType, // PromptType.CONSENT, PromptType.LOGIN or PromptType.SELECT_ACCOUNT
  sid?: string, // Session ID
  loginHint?: string,
  domainHint?: string,
  options?: Configuration // msal js Configuration object
});

  3. Initialize the provider in code with Msal2PublicClientApplicationConfig if a PublicClientApplication is already instantiated. For example, msal-angular instantiates PublicClientApplication on startup.

    import {Providers, LoginType} from '@microsoft/mgt-element';
import {Msal2Provider, PromptType} from '@microsoft/mgt-msal2-provider';
import {PublicClientApplication} from '@azure/msal-browser';

// initialize the auth provider globally
Providers.globalProvider = new Msal2Provider({
  publicClientApplication: PublicClientApplication,
  scopes?: string[],
  authority?: string,
  redirectUri?: string,
  loginType?: LoginType, // LoginType.Popup or LoginType.Redirect (redirect is default)
  prompt?: PromptType, // PromptType.CONSENT, PromptType.LOGIN or PromptType.SELECT_ACCOUNT
  sid?: string, // Session ID
  loginHint?: string,
  domainHint?: string,
  options?: Configuration // msal js Configuration object
});

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

    <script type="module" src="../node_modules/@microsoft/mgt-msal2-provider/dist/es6/index.js" />

<mgt-msal2-provider client-id="<YOUR_CLIENT_ID>"
                  login-type="redirect/popup" 
                  scopes="user.read,people.read" 
                  redirect-uri="https://my.redirect/uri" 
                  authority=""> 
</mgt-msal2-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