@azure/msal-react
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.0 • Public • Published

    Microsoft Authentication Library for React (msal-react)

    npm version npm version codecov

    Getting Started AAD Docs Library Reference Samples
    1. About
    2. FAQ
    3. Changelog
    4. Prerequisites
    5. Installation
    6. Build and Test
    7. Usage
    8. Samples
    9. Security Reporting
    10. License
    11. Code of Conduct

    About

    The MSAL library for JavaScript enables client-side JavaScript applications to authenticate users using Azure AD work and school accounts (AAD), Microsoft personal accounts (MSA) and social identity providers like Facebook, Google, LinkedIn, Microsoft accounts, etc. through Azure AD B2C service. It also enables your app to get tokens to access Microsoft Cloud services such as Microsoft Graph.

    The @azure/msal-react package described by the code in this folder uses the @azure/msal-browser package as a peer dependency to enable authentication in Javascript Single-Page Applications without backend servers. This version of the library uses the OAuth 2.0 Authorization Code Flow with PKCE. To read more about this protocol, as well as the differences between implicit flow and authorization code flow, see the section in the @azure/msal-browser readme.

    Prerequisites

    Installation

    The MSAL React package is available on NPM.

    npm install react react-dom
    npm install @azure/msal-react @azure/msal-browser

    Build and Test

    See the contributing.md file for more information.

    Building the package locally

    To build the @azure/msal-react library, you can do the following:

    // Install dev dependencies from root of repo
    npm install
    // Change to the msal-react package directory
    cd lib/msal-react/
    // To run build only for react package
    npm run build

    To build both the @azure/msal-react library and @azure/msal-browser libraries, you can do the following:

    // Install dev dependencies from root of repo
    npm install
    // Change to the msal-react package directory
    cd lib/msal-react/
    // To run build for react and browser packages
    npm run build:all

    Running Tests

    @azure/msal-react uses jest to run unit tests and coverage.

    // To run tests
    npm test
    // To run tests with code coverage
    npm run test:coverage

    Usage

    For help getting started with @azure/msal-react please see our getting started doc.

    Migrating from react-aad-msal? Check out our migration guide.

    MSAL Basics

    Since @azure/msal-react is a wrapper around @azure/msal-browser many docs from the msal-browser repo are relevant here as well. For concepts specific to @azure/msal-react please see below

    1. Initialization
    2. Acquiring and using an access token
    3. Managing token lifetimes
    4. Managing Accounts
    5. Logging out

    Advanced Topics

    MSAL React Specific Concepts

    1. Hooks
    2. Events
    3. Class Components
    4. Performance

    Samples

    Our samples directory contains several example apps you can spin up to see how this library can be used in different contexts.

    More advanced samples backed with a tutorial can be found in the Azure Samples space on GitHub:

    Security Reporting

    If you find a security issue with our libraries or services please report it to secure@microsoft.com with as much detail as possible. Your submission may be eligible for a bounty through the Microsoft Bounty program. Please do not post security issues to GitHub Issues or any other public site. We will contact you shortly upon receiving the information. We encourage you to get notifications of when security incidents occur by visiting this page and subscribing to Security Advisory Alerts.

    License

    Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License.

    We Value and Adhere to the Microsoft Open Source Code of Conduct

    This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

    Keywords

    none

    Install

    npm i @azure/msal-react

    DownloadsWeekly Downloads

    54,734

    Version

    1.1.0

    License

    MIT

    Unpacked Size

    183 kB

    Total Files

    26

    Last publish

    Collaborators

    • azuread
    • neagrawa
    • manrath