Package Exports
- @microsoft/mgt-msal2-provider
- @microsoft/mgt-msal2-provider/dist/es6/index.js
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
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
Install the packages
npm install @microsoft/mgt-element @microsoft/mgt-msal2-provider
Initialize the provider in code with
Msal2Configimport {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, isIncrementalConsentDisabled?: boolean, //Disable incremental consent, true by default options?: Configuration // msal js Configuration object });
Initialize the provider in code with
Msal2PublicClientApplicationConfigif aPublicClientApplicationis already instantiated. For example,msal-angularinstantiatesPublicClientApplicationon 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, isIncrementalConsentDisabled?: boolean, //Disable incremental consent, true by default options?: Configuration // msal js Configuration object });
Alternatively, initialize the provider in html (only
client-idis 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>
Add the incremental-consent-disabled boolean attribute if you wish to disable incremental consent.
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.