@azure/msal-node
Advanced tools
The @azure/msal-node package is a Microsoft library that enables Node.js applications to authenticate users and access secured resources in the Microsoft identity platform, such as Microsoft 365, Azure, and other resources that rely on Microsoft accounts. It supports various OAuth 2.0 and OpenID Connect flows.
Authentication
This code sample demonstrates how to configure the MSAL client and get an authorization code URL, which is the first step in the OAuth 2.0 authorization code flow.
const msal = require('@azure/msal-node');
const config = {
auth: {
clientId: 'your_client_id',
authority: 'https://login.microsoftonline.com/common',
clientSecret: 'your_client_secret',
}
};
const cca = new msal.ConfidentialClientApplication(config);
const authCodeUrlParameters = {
scopes: ['user.read'],
redirectUri: 'http://localhost:3000/redirect',
};
cca.getAuthCodeUrl(authCodeUrlParameters).then((response) => {
console.log(response);
});Acquiring Tokens
This code sample shows how to exchange an authorization code for an access token, which can be used to access secured resources.
const tokenRequest = {
code: 'authorization_code_received_from_auth_code_url',
scopes: ['user.read'],
redirectUri: 'http://localhost:3000/redirect',
};
cca.acquireTokenByCode(tokenRequest).then((response) => {
console.log(response);
}).catch((error) => {
console.error(error);
});Silent Token Acquisition
This code sample illustrates how to silently acquire an access token using a cached account, which is useful for renewing tokens without user interaction.
const silentTokenRequest = {
account: cca.getAccountByHomeId('user_home_id'),
scopes: ['user.read'],
};
cca.acquireTokenSilent(silentTokenRequest).then((response) => {
console.log(response);
}).catch((error) => {
if (error instanceof msal.InteractionRequiredAuthError) {
// Fallback to interactive method if silent acquisition fails
}
});Passport-azure-ad is a collection of Passport Strategies to help you integrate with Azure Active Directory. It is similar to @azure/msal-node but uses the Passport.js framework, which is popular for handling authentication in Node.js applications.
The oidc-client package provides a client-side library for web applications that need to perform OpenID Connect (OIDC) and OAuth 2.0 protocols. Unlike @azure/msal-node, which is designed for server-side Node.js applications, oidc-client is intended for use in browser-based applications.
Simple-oauth2 is a Node.js library for interacting with OAuth 2.0 and simplifying the process of adding token-based authentication to applications. It provides a simpler and more lightweight alternative to @azure/msal-node, but it does not have specific integrations with Microsoft identity platform.
| Getting Started | AAD Docs | Library Reference |
|---|
MSAL Node enables 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 current version supports the following ways of acquiring tokens:
[Coming Soon] In the future we plan to add support for:
More details on different grant types supported by Microsoft authentication libraries in general can be found here.
The scenarios supported with this library are:
More details on scenarios and the authentication flows that map to each of them can be found here.
See here.
Before using @azure/msal-node you will need to register your app in the azure portal:
npm install @azure/msal-node
MSAL Node will follow the Long Term Support (LTS) schedule of the Node.js project. Our support plan is as follows.
Any major MSAL Node release:
| MSAL Node version | MSAL support status | Supported Node versions |
|---|---|---|
| 1.x.x | Active development | 10, 12, 14, 16 |
There are multiple samples included in the repository that use MSAL Node to acquire tokens. These samples are currently used for manual testing, and are not meant to be a reference of best practices, therefore use judgement and do not blindly copy this code to any production applications.
AAD samples:
B2C samples:
Others:
npm install -g lernalerna bootstrap from anywhere within microsoft-authentication-library-for-js.git.microsoft-authentication-library-for-js/lib/msal-common and run npm run buildmicrosoft-authentication-library-for-js/lib/msal-node and run npm run build// to link msal-node and msal-common packages
lerna bootstrap
// Change to the msal-node package directory
cd lib/msal-common/
// To run build only for node package
npm run build
// Change to the msal-node package directory
cd lib/msal-node/
// To run build only for node package
npm run build
Below is a list of commands you will probably find useful:
npm run build:modules:watchRuns the project in development/watch mode. Your project will be rebuilt upon changes. TSDX has a special logger for you convenience. Error messages are pretty printed and formatted for compatibility VS Code's Problems tab. The library will be rebuilt if you make edits.
npm run buildBundles the package to the dist folder.
The package is optimized and bundled with Rollup into multiple formats (CommonJS, UMD, and ES Module).
lerna bootstrapIf you are running the project in development/watch mode, or have made changes in msal-common and need them reflecting across the project, please run lerna bootstrap to link all the symbols. Please note that npm install will unlink all the code, hence it is advised to run lerna bootstrap post installation.
npm run lintRuns eslint with Prettier
npm test, npm run test:coverage, npm run test:watchRuns the test watcher (Jest) in an interactive mode. By default, runs tests related to files changed since the last commit. Generate code coverage by adding the flag --coverage. No additional setup needed. Jest can collect code coverage information from entire projects, including untested files.
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.
Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License.
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.
FAQs
Microsoft Authentication Library for Node
The npm package @azure/msal-node receives a total of 2,955,676 weekly downloads. As such, @azure/msal-node popularity was classified as popular.
We found that @azure/msal-node demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.