@azure/msal-node package
Node |
This class implements Storage for node, reading cache from user specified storage location or an extension library |
Token |
In-memory token cache manager |
Distributed |
|
Deserializer |
This class deserializes cache entities read from the file into in memory object types defined internally |
Serializer | |
Client |
Base abstract class for all ClientApplications - public and confidential |
Client |
Client assertion of type jwt-bearer used in confidential client flows |
Confidential |
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 |
Public |
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. |
Crypto |
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). |
Guid |
|
Hash |
|
Pkce |
|
Node |
|
Http |
This class implements the API for network requests. |
Loopback |
|
Encoding |
|
Network |
IToken |
Token cache interface for the client, giving access to cache APIs |
ICache |
|
IPartition |
|
IConfidential |
Interface for the ConfidentialClientApplication class defining the public API signatures |
IPublic |
Interface for the PublicClientApplication class defining the public API signatures |
Cache |
Key value store for in-memory cache |
In |
Intermittent type to handle in-memory data objects with defined types |
Json |
Cache format read from the cache blob provided to the configuration during app instantiation |
Serialized |
Access token credential type |
Serialized |
Account type |
Serialized |
AppMetadata type |
Serialized |
Idtoken credential type |
Serialized |
Refresh token credential type |
Cache |
Use this to configure the below cache configuration options:
|
Configuration |
Use the configuration object to configure MSAL and initialize the client application object
|
Node |
|
Node |
|
Node |
Type for configuring logger and http client options
|
Node |
|
Authorization |
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)
|
Authorization |
Request object passed by user to retrieve a Code from the server (first leg of authorization code grant flow)
|
Client |
CommonClientCredentialRequest
|
Device |
Parameters for Oauth2 device code flow.
|
Interactive |
|
On |
|
Refresh |
CommonRefreshTokenRequest
|
Silent |
SilentFlow parameters passed by the user to retrieve credentials silently
|
Username |
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.
|
Api |
API Codes for Telemetry purposes. Before adding a new code you must claim it in the MSAL Telemetry tracker as these number spaces are shared across all MSALs 0-99 Silent Flow 600-699 Device Code Flow 800-899 Auth Code Flow |
Http |
http methods |
Http |
|
Proxy |
buildAppConfiguration({ auth: { authority?: string, authorityMetadata?: string, azureCloudOptions?: AzureCloudOptions, clientAssertion?: string, clientCapabilities?: Array<string>, clientCertificate?: { privateKey: string, thumbprint: string, x5c?: string }, clientId: string, clientSecret?: string, cloudDiscoveryMetadata?: string, knownAuthorities?: Array<string>, protocolMode?: ProtocolMode, skipAuthorityMetadataCache?: boolean }, cache: { cachePlugin?: ICachePlugin }, system: { loggerOptions?: LoggerOptions, networkClient?: INetworkModule, proxyUrl?: string }, telemetry: { application?: ApplicationTelemetry } })
Sets the default options when not explicitly configured from app developer
function buildAppConfiguration(__namedParameters: { auth: { authority?: string, authorityMetadata?: string, azureCloudOptions?: AzureCloudOptions, clientAssertion?: string, clientCapabilities?: Array<string>, clientCertificate?: { privateKey: string, thumbprint: string, x5c?: string }, clientId: string, clientSecret?: string, cloudDiscoveryMetadata?: string, knownAuthorities?: Array<string>, protocolMode?: ProtocolMode, skipAuthorityMetadataCache?: boolean }, cache: { cachePlugin?: ICachePlugin }, system: { loggerOptions?: LoggerOptions, networkClient?: INetworkModule, proxyUrl?: string }, telemetry: { application?: ApplicationTelemetry } }): NodeConfiguration
Parameters
- __namedParameters
-
{ auth: { authority?: string, authorityMetadata?: string, azureCloudOptions?: AzureCloudOptions, clientAssertion?: string, clientCapabilities?: Array<string>, clientCertificate?: { privateKey: string, thumbprint: string, x5c?: string }, clientId: string, clientSecret?: string, cloudDiscoveryMetadata?: string, knownAuthorities?: Array<string>, protocolMode?: ProtocolMode, skipAuthorityMetadataCache?: boolean }, cache: { cachePlugin?: ICachePlugin }, system: { loggerOptions?: LoggerOptions, networkClient?: INetworkModule, proxyUrl?: string }, telemetry: { application?: ApplicationTelemetry } }
Returns
Configuration