MSAL.js for React Sample - Authorization Code Flow in Single-Page Applications

About this sample

This developer sample is used to run basic use cases for the MSAL library. You can also alter the configuration in ./src/authConfig.js to execute other behaviors. This sample was bootstrapped with Create React App.

Notable files and what they demonstrate

1. ./src/App.js - Shows implementation of MsalProvider, all children will have access to @azure/msal-react context, hooks and components.
2. ./src/index.js - Shows intialization of the PublicClientApplication that is passed to App.js
3. ./src/pages/Home.jsx - Homepage, shows how to conditionally render content using AuthenticatedTemplate and UnauthenticatedTemplate depending on whether or not a user is signed in.
4. ./src/pages/Profile.jsx - Example of a protected route using MsalAuthenticationTemplate. If a user is not yet signed in, signin will be invoked automatically. If a user is signed in it will acquire an access token and make a call to MS Graph to fetch user profile data.
5. ./src/authConfig.js - Configuration options for PublicClientApplication and token requests.
6. ./src/ui-components/SignInSignOutButton.jsx - Example of how to conditionally render a Sign In or Sign Out button using the useIsAuthenticated hook.
7. ./src/ui-components/SignInButton.jsx - Example of how to get the PublicClientApplication instance using the useMsal hook and invoking a login function.
8. ./src/ui-components/SignOutButton.jsx - Example of how to get the PublicClientApplication instance using the useMsal hook and invoking a logout function.
9. ./src/utils/MsGraphApiCall.js - Example of how to call the MS Graph API with an access token.
10. ./src/utils/NavigationClient.js - Example implementation of INavigationClient which can be used to override the default navigation functions MSAL.js uses

(Optional) MSAL React and class components

For a demonstration of how to use MSAL React with class components, see: ./src/pages/ProfileWithMsal.jsx and ./src/pages/ProfileRawContext.jsx.

After you initialize MsalProvider, there are 3 approaches you can take to protect your class components with MSAL React:

1. Wrap each component that you want to protect with withMsal higher-order component (HOC) (e.g. Profile).
2. Consume the raw context directly (e.g. ProfileContent).
3. Pass context down from a parent component that has access to the msalContext via one of the other means above (e.g. ProfileContent).

For more information, visit:

• Docs: Class Components
• MSAL React FAQ

How to run the sample

Pre-requisites

• Ensure all pre-requisites have been completed to run @azure/msal-react.
• Install node.js if needed (https://nodejs.org/en/).

Configure the application

• Open ./env.development in an editor.
• Replace ENTER_CLIENT_ID_HERE with the Application (client) ID from the portal registration, or use the currently configured lab registration.
• Replace ENTER_TENANT_ID_HERE with the tenant ID from the portal registration, or use the currently configured lab registration.
  • Optionally, you may replace any of the other parameters, or you can remove them and use the default values.

These parameters are used in ./src/authConfig.js to configure MSAL.

Install npm dependencies for sample

# Install dev dependencies for msal-react and msal-browser from root of repo
npm install

# Change directory to sample directory
cd samples/msal-react-samples/react-router-sample

# Build packages locally
npm run build:package

Running the sample development server

1. In a command prompt, run npm start.
2. Open http://localhost:3000 to view it in the browser.
3. Open http://localhost:3000/profile to see an example of a protected route. If you are not yet signed in, signin will be invoked automatically.

The page will reload if you make edits. You will also see any lint errors in the console.

• In the web page, click on the "Login" button and select either Sign in using Popup or Sign in using Redirect to begin the auth flow.

Running the sample production server

1. In a command prompt, run npm run build.
2. Next run serve -s build
3. Open http://localhost:3000 to view it in the browser.
4. Open http://localhost:3000/profile to see an example of a protected route. If you are not yet signed in, signin will be invoked automatically.

Running the sample in IE11

@azure/msal-react and @azure/msal-browser support IE11 but the react-scripts package requires a few polyfills to work properly. In order to run this sample in IE11 go to src/index.js and uncomment the first 2 imports. We recommend using the redirect flow and setting the storeAuthStateInCookie config parameter to true in IE11 as there are known issues with popups. You can read more about the known issues with IE11 here

Learn more about the 3rd-party libraries used to create this sample

• React documentation.
• Create React App documentation
• React Router documentation
• Material-UI documentation