@microsoft/mgt-msal2-provider
TypeScript icon, indicating that this package has built-in type declarations

4.2.2 • Public • Published

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. This provider also supports multiple account logins.

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/dist/es6/exports';
    
    // 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,
      isMultiAccountEnabled?: boolean, // True by default, disables multiple account login if false
      isIncrementalConsentDisabled?: boolean, //Disable incremental consent, true by default
      isMultiAccountEnabled?: boolean // True by default, disables multiple account login if false
      isIncrementalConsentDisabled?: boolean, //Disable incremental consent, true by default
      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/dist/es6/exports';
    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,
      isMultiAccountEnabled?: boolean, // True by default, disables multiple account login if false
      isIncrementalConsentDisabled?: boolean, //Disable incremental consent, true by default
    });
  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=""
                      login-hint=""
                      domain-hint="">
    </mgt-msal2-provider>

Add the incremental-consent-disabled boolean attribute if you wish to disable incremental consent.

  1. Multi account login functionality is enabled by default. It can be disabled by adding the boolean attribute multi-account-disabled in the html:

    <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=""
                      multi-account-disabled>
    </mgt-msal2-provider>

    It can also be enabled/disabled in the Msal2Config object:

    import {Providers, LoginType} from '@microsoft/mgt-element';
    import {Msal2Provider, PromptType} from '@microsoft/mgt-msal2-provider/dist/es6/exports';
    
    // initialize the auth provider globally
    Providers.globalProvider = new Msal2Provider({
      clientId: 'clientId',
      isMultiAccountEnabled?: false
    });

This feature allows multiple accounts to be signed in at the same time, and the user has the ability to switch between the signed in accounts.

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

Package Sidebar

Install

npm i @microsoft/mgt-msal2-provider

Weekly Downloads

8,692

Version

4.2.2

License

MIT

Unpacked Size

202 kB

Total Files

23

Last publish

Collaborators

  • microsoft-graph-toolkit
  • microsoft1es