@azure/msal-node package

General error class thrown by the MSAL.js library.

Base abstract class for all ClientApplications - public and confidential

Client assertion of type jwt-bearer used in confidential client flows

Error thrown when there is an error in the client code running on the browser.

Error thrown when there is an error in configuration of the MSAL.js library.

OAuth2.0 client credential grant

This class is to be used to acquire tokens for confidential client applications (webApp, webAPI). Confidential client applications will configure application secrets, client certificates/assertions as applicable

This class implements MSAL node's crypto interface, which allows it to perform base64 encoding and decoding, generating cryptographically random GUIDs and implementing Proof Key for Code Exchange specs for the OAuth Authorization Code Flow using PKCE (rfc here: https://tools.ietf.org/html/rfc7636).

OAuth2.0 Device code client

Cache plugin that serializes data to the cache and deserializes data from the cache

Error thrown when user interaction is required.

Class which facilitates logging of messages to a specific place.

Class to initialize a managed identity and identify the service

On-Behalf-Of client

This class is to be used to acquire tokens for public client applications (desktop, mobile). Public client applications are not trusted to safely store application secrets, and therefore can only request tokens in the name of an user.

Error thrown when there is an error with the server code, for example, unavailability.

In-memory token cache manager

This class instance helps track the memory changes facilitating decisions to read from and write to the persistent cache

Oauth2.0 Password grant client Note: We are only supporting public clients for password grant and for purely testing purposes

Interface for the cache that defines a getter and setter

Interface for the ConfidentialClientApplication class defining the public API signatures

Interface for LoopbackClient allowing to replace the default loopback server with a custom implementation.

Client network interface to send backend requests.

Interface that defines getter methods to get keys used to identity data in the cache

Interface for the PublicClientApplication class defining the public API signatures

Token cache interface for the client, giving access to cache APIs

Account object with the following signature:

• homeAccountId - Home account identifier for this account object
• environment - Entity which issued the token represented by the domain of the issuer (e.g. login.microsoftonline.com)
• tenantId - Full tenant or organizational id that this account belongs to
• username - preferred_username claim of the id_token that represents this account
• localAccountId - Local, tenant-specific account identifer for this account object, usually used in legacy cases
• name - Full name for the account, including given name and family name
• idToken - raw ID token
• idTokenClaims - Object contains claims from ID token
• nativeAccountId - The user's native account ID
• tenantProfiles - Map of tenant profile objects for each tenant that the account has authenticated with in the browser

Input object for the IAppTokenProvider extensiblity. MSAL will create this object, which can be used to help create an AppTokenProviderResult.

• correlationId - the correlation Id associated with the request
• tenantId - the tenant Id for which the token must be provided
• scopes - the scopes for which the token must be provided
• claims - any extra claims that the token must satisfy

Output object for IAppTokenProvider extensiblity.

• accessToken - the actual access token, typically in JWT format, that satisfies the request data AppTokenProviderParameters
• expiresInSeconds - how long the tokens has before expiry, in seconds. Similar to the "expires_in" field in an AAD token response.
• refreshInSeconds - how long the token has before it should be proactively refreshed. Similar to the "refresh_in" field in an AAD token response.

Result returned from the authority's token endpoint.

• uniqueId - oid or sub claim from ID token
• tenantId - tid claim from ID token
• scopes - Scopes that are validated for the respective token
• account - An account object representation of the currently signed-in user
• idToken - Id token received as part of the response
• idTokenClaims - MSAL-relevant ID token claims
• accessToken - Access token or SSH certificate received as part of the response
• fromCache - Boolean denoting whether token came from cache
• expiresOn - Javascript Date object representing relative expiration of access token
• extExpiresOn - Javascript Date object representing extended relative expiration of access token in case of server outage
• refreshOn - Javascript Date object representing relative time until an access token must be refreshed
• state - Value passed in by user in request
• familyId - Family ID identifier, usually only used for refresh tokens
• requestId - Request ID returned as part of the response

Response returned after processing the code response query string or fragment.

Request object passed by user to acquire a token from the server exchanging a valid authorization code (second leg of OAuth2.0 Authorization Code flow)

• scopes - Array of scopes the application is requesting access to.
• claims - A stringified claims request which will be added to all /authorize and /token calls
• authority: - URL of the authority, the security token service (STS) from which MSAL will acquire tokens. If authority is set on client application object, this will override that value. Overriding the value will cause for authority validation to happen each time. If the same authority will be used for all request, set on the application object instead of the requests.
• correlationId - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
• redirectUri - The redirect URI of your app, where the authority will redirect to after the user inputs credentials and consents. It must exactly match one of the redirect URIs you registered in the portal.
• tokenQueryParameters - String to string map of custom query parameters added to the /token call
• code - The authorization_code that the user acquired in the first leg of the flow.
• codeVerifier - The same code_verifier that was used to obtain the authorization_code. Required if PKCE was used in the authorization code grant request.For more information, see the PKCE RFC: https://tools.ietf.org/html/rfc7636
• state - Unique GUID generated by the user that is cached by the user and sent to the server during the first leg of the flow. This string is sent back by the server with the authorization code. The user cached state is then compared with the state received from the server to mitigate the risk of CSRF attacks. See https://datatracker.ietf.org/doc/html/rfc6819#section-3.6.

Request object passed by user to retrieve a Code from the server (first leg of authorization code grant flow)

• scopes - Array of scopes the application is requesting access to.
• claims - A stringified claims request which will be added to all /authorize and /token calls
• authority - Url of the authority which the application acquires tokens from.
• correlationId - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
• redirectUri - The redirect URI where authentication responses can be received by your application. It must exactly match one of the redirect URIs registered in the Azure portal.
• extraScopesToConsent - Scopes for a different resource when the user needs consent upfront.
• responseMode - Specifies the method that should be used to send the authentication result to your app. Can be query, form_post, or fragment. If no value is passed in, it defaults to query.
• codeChallenge - Used to secure authorization code grant via Proof of Key for Code Exchange (PKCE). For more information, see the PKCE RCF:https://tools.ietf.org/html/rfc7636
• codeChallengeMethod - The method used to encode the code verifier for the code challenge parameter. Can be "plain" or "S256". If excluded, code challenge is assumed to be plaintext. For more information, see the PKCE RCF: https://tools.ietf.org/html/rfc7636
• state - A value included in the request that is also returned in the token response. A randomly generated unique value is typically used for preventing cross site request forgery attacks. The state is also used to encode information about the user's state in the app before the authentication request occurred.
• prompt - Indicates the type of user interaction that is required. login: will force the user to enter their credentials on that request, negating single-sign on none: will ensure that the user isn't presented with any interactive prompt. if request can't be completed via single-sign on, the endpoint will return an interaction_required error consent: will the trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app select_account: will interrupt single sign-=on providing account selection experience listing all the accounts in session or any remembered accounts or an option to choose to use a different account create: will direct the user to the account creation experience instead of the log in experience
• account - AccountInfo obtained from a getAccount API. Will be used in certain scenarios to generate login_hint if both loginHint and sid params are not provided.
• loginHint - Can be used to pre-fill the username/email address field of the sign-in page for the user, if you know the username/email address ahead of time. Often apps use this parameter during re-authentication, having already extracted the username from a previous sign-in using the preferred_username claim.
• sid - Session ID, unique identifier for the session. Available as an optional claim on ID tokens.
• domainHint - Provides a hint about the tenant or domain that the user should use to sign in. The value of the domain hint is a registered domain for the tenant.
• extraQueryParameters - String to string map of custom query parameters added to the /authorize call
• tokenQueryParameters - String to string map of custom query parameters added to the /token call
• nonce - A value included in the request that is returned in the id token. A randomly generated unique value is typically used to mitigate replay attacks.

Response properties that may be returned by the /authorize endpoint

AzureCloudInstance specific options

• azureCloudInstance - string enum providing short notation for soverign and public cloud authorities
• tenant - provision to provide the tenant info

Use this to configure the below broker options:

• nativeBrokerPlugin - Native broker implementation (should be imported from msal-node-extensions)

Note: These options are only available for PublicClientApplications using the Authorization Code Flow

Key value store for in-memory cache

Use this to configure the below cache configuration options:

• cachePlugin - Plugin for reading and writing token cache to disk.

CommonClientCredentialRequest

• scopes - Array of scopes the application is requesting access to. Typically contains only the .default scope for a single resource. See: https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc#the-default-scope
• authority - URL of the authority, the security token service (STS) from which MSAL will acquire tokens.
• correlationId - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
• skipCache - Skip token cache lookup and force request to authority to get a a new token. Defaults to false.
• clientAssertion - An assertion string or a callback function that returns an assertion string (both are Base64Url-encoded signed JWTs) used in the Client Credential flow
• tokenQueryParameters - String to string map of custom query parameters added to the /token call

Use the configuration object to configure MSAL and initialize the client application object

• auth: this is where you configure auth elements like clientID, authority used for authenticating against the Microsoft Identity Platform
• broker: this is where you configure broker options
• cache: this is where you configure cache location
• system: this is where you can configure the network client, logger
• telemetry: this is where you can configure telemetry options

Parameters for Oauth2 device code flow.

• scopes - Array of scopes the application is requesting access to.
• authority: - URL of the authority, the security token service (STS) from which MSAL will acquire tokens. If authority is set on client application object, this will override that value. Overriding the value will cause for authority validation to happen each time. If the same authority will be used for all request, set on the application object instead of the requests.
• correlationId - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
• deviceCodeCallback - Callback containing device code response. Message should be shown to end user. End user can then navigate to the verification_uri, input the user_code, and input credentials.
• cancel - Boolean to cancel polling of device code endpoint. While the user authenticates on a separate device, MSAL polls the the token endpoint of security token service for the interval specified in the device code response (usually 15 minutes). To stop polling and cancel the request, set cancel=true.
• extraQueryParameters - String to string map of custom query parameters added to the query string

Type which describes Id Token claims known by MSAL.

Intermittent type to handle in-memory data objects with defined types

Request object passed by user to configure acquireTokenInteractive API

• openBrowser - Function to open a browser instance on user's system.
• scopes - Array of scopes the application is requesting access to.
• successTemplate: - Template to be displayed on the opened browser instance upon successful token acquisition.
• errorTemplate - Template to be displayed on the opened browser instance upon token acquisition failure.
• windowHandle - Used in native broker flows to properly parent the native broker window
• loopbackClient - Custom implementation for a loopback server to listen for authorization code response.

Cache format read from the cache blob provided to the configuration during app instantiation

ManagedIdentityRequest

• claims - a stringified claims request which will be used to determine whether or not the cache should be skipped
• forceRefresh - forces managed identity requests to skip the cache and make network calls if true
• resource - resource requested to access the protected API. It should be of the form "ResourceIdUri" or "ResourceIdUri/.default". For instance https://management.azure.net or, for Microsoft Graph, https://graph.microsoft.com/.default

The ManagedIdentitySourceNames type

Options allowed by network request APIs.

• clientId - Client id of the application.
• authority - Url of the authority. If no value is set, defaults to https://login.microsoftonline.com/common.
• knownAuthorities - Needed for Azure B2C and ADFS. All authorities that will be used in the client application. Only the host of the authority should be passed in.
• clientSecret - Secret string that the application uses when requesting a token. Only used in confidential client applications. Can be created in the Azure app registration portal.
• clientAssertion - A ClientAssertion object containing an assertion string or a callback function that returns an assertion string that the application uses when requesting a token, as well as the assertion's type (urn:ietf:params:oauth:client-assertion-type:jwt-bearer). Only used in confidential client applications.
• clientCertificate - Certificate that the application uses when requesting a token. Only used in confidential client applications. Requires hex encoded X.509 SHA-1 or SHA-256 thumbprint of the certificate, and the PEM encoded private key (string should contain -----BEGIN PRIVATE KEY----- ... -----END PRIVATE KEY----- )
• protocolMode - Enum that represents the protocol that msal follows. Used for configuring proper endpoints.
• skipAuthorityMetadataCache - A flag to choose whether to use or not use the local metadata cache during authority initialization. Defaults to false.
• encodeExtraQueryParams - A flag to choose whether to encode extra query parameters in the request URL. Defaults to false.

Type for configuring logger and http client options

• logger - Used to initialize the Logger object; TODO: Expand on logger details or link to the documentation on logger
• networkClient - Http client used for all http get and post calls. Defaults to using MSAL's default http client.

• scopes - Array of scopes the application is requesting access to.
• authority - URL of the authority, the security token service (STS) from which MSAL will acquire tokens.
• correlationId - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
• oboAssertion - The access token that was sent to the middle-tier API. This token must have an audience of the app making this OBO request.
• skipCache - Skip token cache lookup and force request to authority to get a a new token. Defaults to false.
• tokenQueryParameters - String to string map of custom query parameters added to the /token call

CommonRefreshTokenRequest

• scopes - Array of scopes the application is requesting access to.
• claims - A stringified claims request which will be added to all /authorize and /token calls
• authority - URL of the authority, the security token service (STS) from which MSAL will acquire tokens.
• correlationId - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
• refreshToken - A refresh token returned from a previous request to the Identity provider.
• tokenQueryParameters - String to string map of custom query parameters added to the /token call
• forceCache - Force MSAL to cache a refresh token flow response when there is no account in the cache. Used for migration scenarios.

Access token credential type

Account type

AppMetadata type

Idtoken credential type

Refresh token credential type

SilentFlow parameters passed by the user to retrieve credentials silently

• scopes - Array of scopes the application is requesting access to.
• claims - A stringified claims request which will be added to all /authorize and /token calls. When included on a silent request, cache lookup will be skipped and token will be refreshed.
• authority - Url of the authority which the application acquires tokens from.
• correlationId - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
• tokenQueryParameters - String to string map of custom query parameters added to the /token call
• account - Account entity to lookup the credentials.
• forceRefresh - Forces silent requests to make network calls if true.

UsernamePassword parameters passed by the user to retrieve credentials Note: The latest OAuth 2.0 Security Best Current Practice disallows the password grant entirely. This flow is added for internal testing.

• scopes - Array of scopes the application is requesting access to.
• claims - A stringified claims request which will be added to all /authorize and /token calls. When included on a silent request, cache lookup will be skipped and token will be refreshed.
• authority - Url of the authority which the application acquires tokens from.
• correlationId - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
• username - username of the client
• password - credentials
• tokenQueryParameters - String to string map of custom query parameters added to the /token call

Log message level.