@azure/msal-node package
Klassen
| AuthError |
Allgemeine Fehlerklasse, die von der MSAL.js Bibliothek ausgelöst wird. |
| ClientApplication |
Basis-abstrakte Klasse für alle ClientApplications – öffentlich und vertraulich |
| ClientAssertion |
Client assertion vom Typ jwt-bearer, der in vertraulichen Clientflüssen verwendet wird |
| ClientAuthError |
Fehler ausgelöst, wenn im Clientcode, der im Browser ausgeführt wird, ein Fehler auftritt. |
| ClientConfigurationError |
Fehler ausgelöst, wenn bei der Konfiguration der MSAL.js-Bibliothek ein Fehler auftritt. |
| ClientCredentialClient |
Genehmigung von OAuth2.0-Clientanmeldeinformationen |
| ConfidentialClientApplication |
Diese Klasse dient zum Abrufen von Token für vertrauliche Clientanwendungen (webApp, webAPI). Vertrauliche Clientanwendungen konfigurieren anwendungsgeheimnisse, Clientzertifikate/Assertionen wie zutreffend |
| CryptoProvider |
Diese Klasse implementiert die Kryptoschnittstelle des MSAL-Knotens, die es ermöglicht, base64-Codierung und Decodierung durchzuführen, kryptografisch zufällige GUIDs zu generieren und Proof Key für Code Exchange Spezifikationen für den OAuth-Autorisierungscodefluss mithilfe von PKCE (rfc: ) zu implementieren. https://tools.ietf.org/html/rfc7636 |
| DeviceCodeClient |
OAuth2.0-Gerätecodeclient |
| DistributedCachePlugin |
Cache-Plug-In, das Daten in den Cache serialisiert und Daten aus dem Cache deserialisiert |
| InteractionRequiredAuthError |
Fehler, der ausgelöst wird, wenn eine Benutzerinteraktion erforderlich ist. |
| Logger |
Klasse, die die Protokollierung von Nachrichten an einem bestimmten Ort erleichtert. |
| ManagedIdentityApplication |
Klasse zum Initialisieren einer verwalteten Identität und Identifizieren des Diensts |
| OnBehalfOfClient |
On-Behalf-Of Client |
| PublicClientApplication |
Diese Klasse wird verwendet, um Token für öffentliche Clientanwendungen (Desktop, Mobil) zu erwerben. Öffentliche Clientanwendungen sind nicht vertrauenswürdig, um geheime Anwendungsschlüssel sicher zu speichern, und daher können nur Token im Namen eines Benutzers angefordert werden. |
| ServerError |
Fehler, der ausgelöst wird, wenn ein Fehler mit dem Servercode auftritt, z. B. nicht verfügbar. |
| TokenCache |
Cache-Manager für In-Memory-Token |
| TokenCacheContext |
Diese Klasseninstanz hilft, die Speicheränderungen nachzuverfolgen, wodurch Entscheidungen zum Lesen und Schreiben in den persistenten Cache erleichtert werden. |
| UsernamePasswordClient |
Oauth2.0-Clienthinweis zur Kennworterteilung: Wir unterstützen nur öffentliche Clients für die Kennworterteilung und ausschließlich zu Testzwecken. |
Schnittstellen
| IAppTokenProvider | |
| ICacheClient |
Schnittstelle für den Cache, der einen Getter und Setter definiert |
| ICachePlugin | |
| IConfidentialClientApplication |
Schnittstelle für die ConfidentialClientApplication-Klasse, die die öffentlichen API-Signaturen definiert |
| ILoopbackClient |
Schnittstelle für LoopbackClient, mit der der Standard-Loopbackserver durch eine benutzerdefinierte Implementierung ersetzt werden kann. |
| INativeBrokerPlugin | |
| INetworkModule |
Clientnetzwerkschnittstelle zum Senden von Back-End-Anforderungen. |
| IPartitionManager |
Schnittstelle, die getter-Methoden definiert, um Schlüssel abzurufen, die für Identitätsdaten im Cache verwendet werden |
| IPublicClientApplication |
Schnittstelle für die PublicClientApplication-Klasse, die die öffentlichen API-Signaturen definiert |
| ISerializableTokenCache | |
| ITokenCache |
Tokencacheschnittstelle für den Client, wodurch Der Zugriff auf Cache-APIs ermöglicht wird |
Typaliase
| AccountInfo |
Account-Objekt mit der folgenden Signatur:
|
| AppTokenProviderParameters |
Input-Objekt für die IAppTokenProvider-Erweiterbarkeit. MSAL erstellt dieses Objekt, das zum Erstellen eines AppTokenProviderResult verwendet werden kann.
|
| AppTokenProviderResult |
Ausgabeobjekt für die IAppTokenProvider-Erweiterbarkeit.
|
| AuthenticationResult |
Ergebnis, das vom Tokenendpunkt der Autorität zurückgegeben wird.
|
| AuthorizationCodePayload |
Antwort, die nach der Verarbeitung der Codeantwortabfragezeichenfolge oder des Fragments zurückgegeben wurde. |
| AuthorizationCodeRequest |
Anforderungsobjekt, das vom Benutzer übergeben wird, um ein Token vom Server abzurufen, der einen gültigen Autorisierungscode austauscht (zweiter Teil des OAuth2.0-Autorisierungscodeflusses)
|
| AuthorizationUrlRequest |
Anforderungsobjekt, das vom Benutzer übergeben wird, um einen Code vom Server abzurufen (First Leg of Authorization Code Grant Flow)
|
| AuthorizeResponse |
Antworteigenschaften, die vom /authorize-Endpunkt zurückgegeben werden können |
| AzureCloudOptions |
Spezifische AzureCloudInstance-Optionen
|
| BrokerOptions |
Verwenden Sie diese Option, um die folgenden Brokeroptionen zu konfigurieren:
Hinweis: Diese Optionen sind nur für PublicClientApplications mit dem Autorisierungscodefluss verfügbar. |
| CacheKVStore |
Schlüsselwertspeicher für speicherinternen Cache |
| CacheOptions |
Verwenden Sie diese Option, um die folgenden Cachekonfigurationsoptionen zu konfigurieren:
|
| ClientAssertionCallback | |
| ClientCredentialRequest |
CommonClientCredentialRequest
|
| Configuration |
Verwenden des Konfigurationsobjekts zum Konfigurieren von MSAL und Initialisieren des Clientanwendungsobjekts
|
| DeviceCodeRequest |
Parameter für den Oauth2-Gerätecodefluss.
|
| IdTokenClaims |
Typ, der ID-Tokenansprüche beschreibt, die von MSAL bekannt sind. |
| InMemoryCache |
Intermittierender Typ zum Behandeln von In-Memory-Datenobjekten mit definierten Typen |
| InteractiveRequest |
Vom Benutzer übergebenes Anforderungsobjekt zum Konfigurieren der AcquireTokenInteractive-API
|
| JsonCache |
Cacheformatlesevorgang aus dem Cache-BLOB, das während der App-Instanziierung für die Konfiguration bereitgestellt wird |
| ManagedIdentityConfiguration | |
| ManagedIdentityIdParams | |
| ManagedIdentityRequestParams |
ManagedIdentityRequest
|
| NetworkRequestOptions |
Optionen, die von Netzwerkanforderungs-APIs zulässig sind. |
| NetworkResponse | |
| NodeAuthOptions |
|
| NodeSystemOptions |
Typ zum Konfigurieren von Logger- und HTTP-Clientoptionen
|
| NodeTelemetryOptions | |
| OnBehalfOfRequest |
|
| RefreshTokenRequest |
CommonRefreshTokenRequest
|
| SerializedAccessTokenEntity |
Zugriffstoken-Anmeldeinformationstyp |
| SerializedAccountEntity |
Kontotyp |
| SerializedAppMetadataEntity |
AppMetadata-Typ |
| SerializedIdTokenEntity |
Idtoken-Anmeldeinformationstyp |
| SerializedRefreshTokenEntity |
Aktualisierungstoken-Anmeldeinformationstyp |
| SignOutRequest | |
| SilentFlowRequest |
SilentFlow-Parameter, die vom Benutzer übergeben werden, um Anmeldeinformationen im Hintergrund abzurufen
|
| UsernamePasswordRequest |
UsernamePassword-Parameter, die vom Benutzer übergeben werden, um Anmeldeinformationen abzurufen Hinweis: Die neueste bewährte OAuth 2.0 Security Best Current Practice verbietet die Kennworterteilung vollständig. Dieser Fluss wird für interne Tests hinzugefügt.
|
Enumerationen
| LogLevel |
Protokollnachrichtenebene. |
Variablen
| Azure |
|
| Managed |
Namen der verwalteten Identitätsquelle |
| Protocol |
Von MSAL unterstützte Protokollmodi. |
| Response |
zulässige Werte für response_mode |
| Auth |
AuthErrorMessage-Klasse mit Zeichenfolgenkonstanten, die von Fehlercodes und Nachrichten verwendet werden. |
| Client |
Zeichenfolgenkonstanten, die von Fehlercodes und Meldungen verwendet werden. |
| Client |
ClientConfigurationErrorMessage-Klasse mit Zeichenfolgenkonstanten, die von Fehlercodes und Nachrichten verwendet werden. |
| Interaction |
Vom SDK definierte Fehler bei der Interaktion |
| Prompt |
wir haben diese "Enumeration" in der Anforderung anstelle von Zeichenfolgen festgelegt, es sieht jedoch so aus, als ob die Liste der zulässigen Eingabeaufforderungswerte in den letzten Jahren geändert wurde. Es gibt auch einige nicht dokumentierte Eingabeaufforderungswerte für einige interne Partner, daher die Wahl des generischen "string"-Typs anstelle der "Enumeration" |
| version |
Details zu Variablen
AzureCloudInstance
AzureCloudInstance: { AzureChina: "https://login.chinacloudapi.cn", AzureGermany: "https://login.microsoftonline.de", AzurePpe: "https://login.windows-ppe.net", AzurePublic: "https://login.microsoftonline.com", AzureUsGovernment: "https://login.microsoftonline.us", None: "none" }
Typ
{ AzureChina: "https://login.chinacloudapi.cn", AzureGermany: "https://login.microsoftonline.de", AzurePpe: "https://login.windows-ppe.net", AzurePublic: "https://login.microsoftonline.com", AzureUsGovernment: "https://login.microsoftonline.us", None: "none" }
ManagedIdentitySourceNames
Namen der verwalteten Identitätsquelle
ManagedIdentitySourceNames: { APP_SERVICE: "AppService", AZURE_ARC: "AzureArc", CLOUD_SHELL: "CloudShell", DEFAULT_TO_IMDS: "DefaultToImds", IMDS: "Imds", MACHINE_LEARNING: "MachineLearning", SERVICE_FABRIC: "ServiceFabric" }
Typ
{ APP_SERVICE: "AppService", AZURE_ARC: "AzureArc", CLOUD_SHELL: "CloudShell", DEFAULT_TO_IMDS: "DefaultToImds", IMDS: "Imds", MACHINE_LEARNING: "MachineLearning", SERVICE_FABRIC: "ServiceFabric" }
ProtocolMode
Von MSAL unterstützte Protokollmodi.
ProtocolMode: { AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }
Typ
{ AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }
ResponseMode
zulässige Werte für response_mode
ResponseMode: { FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }
Typ
{ FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }
AuthErrorMessage
Warnung
Diese API ist nun veraltet.
Use AuthErrorCodes instead
AuthErrorMessage-Klasse mit Zeichenfolgenkonstanten, die von Fehlercodes und Nachrichten verwendet werden.
AuthErrorMessage: { postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }
Typ
{ postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }
ClientAuthErrorMessage
Warnung
Diese API ist nun veraltet.
Use ClientAuthErrorCodes instead
Zeichenfolgenkonstanten, die von Fehlercodes und Meldungen verwendet werden.
ClientAuthErrorMessage: { DeviceCodeExpired: { code: string, desc: string }, DeviceCodePollingCancelled: { code: string, desc: string }, DeviceCodeUnknownError: { code: string, desc: string }, NoAccountInSilentRequest: { code: string, desc: string }, appendScopeSetError: { code: string, desc: string }, authTimeNotFoundError: { code: string, desc: string }, bindingKeyNotRemovedError: { code: string, desc: string }, clientInfoDecodingError: { code: string, desc: string }, clientInfoEmptyError: { code: string, desc: string }, emptyInputScopeSetError: { code: string, desc: string }, endpointResolutionError: { code: string, desc: string }, hashNotDeserialized: { code: string, desc: string }, invalidAssertion: { code: string, desc: string }, invalidCacheEnvironment: { code: string, desc: string }, invalidCacheRecord: { code: string, desc: string }, invalidClientCredential: { code: string, desc: string }, invalidStateError: { code: string, desc: string }, keyIdMissing: { code: string, desc: string }, logoutNotSupported: { code: string, desc: string }, maxAgeTranspired: { code: string, desc: string }, missingTenantIdError: { code: string, desc: string }, multipleMatchingAccounts: { code: string, desc: string }, multipleMatchingAppMetadata: { code: string, desc: string }, multipleMatchingTokens: { code: string, desc: string }, nestedAppAuthBridgeDisabled: { code: string, desc: string }, networkError: { code: string, desc: string }, noAccountFound: { code: string, desc: string }, noAuthorizationCodeFromServer: { code: string, desc: string }, noCryptoObj: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, nonceMismatchError: { code: string, desc: string }, nullOrEmptyToken: { code: string, desc: string }, platformBrokerError: { code: string, desc: string }, removeEmptyScopeError: { code: string, desc: string }, stateMismatchError: { code: string, desc: string }, stateNotFoundError: { code: string, desc: string }, tokenClaimsRequired: { code: string, desc: string }, tokenParsingError: { code: string, desc: string }, tokenRefreshRequired: { code: string, desc: string }, tokenRequestCannotBeMade: { code: string, desc: string }, unableToGetOpenidConfigError: { code: string, desc: string }, unexpectedCredentialType: { code: string, desc: string }, userCanceledError: { code: string, desc: string }, userTimeoutReached: { code: string, desc: string } }
Typ
{ DeviceCodeExpired: { code: string, desc: string }, DeviceCodePollingCancelled: { code: string, desc: string }, DeviceCodeUnknownError: { code: string, desc: string }, NoAccountInSilentRequest: { code: string, desc: string }, appendScopeSetError: { code: string, desc: string }, authTimeNotFoundError: { code: string, desc: string }, bindingKeyNotRemovedError: { code: string, desc: string }, clientInfoDecodingError: { code: string, desc: string }, clientInfoEmptyError: { code: string, desc: string }, emptyInputScopeSetError: { code: string, desc: string }, endpointResolutionError: { code: string, desc: string }, hashNotDeserialized: { code: string, desc: string }, invalidAssertion: { code: string, desc: string }, invalidCacheEnvironment: { code: string, desc: string }, invalidCacheRecord: { code: string, desc: string }, invalidClientCredential: { code: string, desc: string }, invalidStateError: { code: string, desc: string }, keyIdMissing: { code: string, desc: string }, logoutNotSupported: { code: string, desc: string }, maxAgeTranspired: { code: string, desc: string }, missingTenantIdError: { code: string, desc: string }, multipleMatchingAccounts: { code: string, desc: string }, multipleMatchingAppMetadata: { code: string, desc: string }, multipleMatchingTokens: { code: string, desc: string }, nestedAppAuthBridgeDisabled: { code: string, desc: string }, networkError: { code: string, desc: string }, noAccountFound: { code: string, desc: string }, noAuthorizationCodeFromServer: { code: string, desc: string }, noCryptoObj: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, nonceMismatchError: { code: string, desc: string }, nullOrEmptyToken: { code: string, desc: string }, platformBrokerError: { code: string, desc: string }, removeEmptyScopeError: { code: string, desc: string }, stateMismatchError: { code: string, desc: string }, stateNotFoundError: { code: string, desc: string }, tokenClaimsRequired: { code: string, desc: string }, tokenParsingError: { code: string, desc: string }, tokenRefreshRequired: { code: string, desc: string }, tokenRequestCannotBeMade: { code: string, desc: string }, unableToGetOpenidConfigError: { code: string, desc: string }, unexpectedCredentialType: { code: string, desc: string }, userCanceledError: { code: string, desc: string }, userTimeoutReached: { code: string, desc: string } }
ClientConfigurationErrorMessage
Warnung
Diese API ist nun veraltet.
Use ClientConfigurationErrorCodes instead
ClientConfigurationErrorMessage-Klasse mit Zeichenfolgenkonstanten, die von Fehlercodes und Nachrichten verwendet werden.
ClientConfigurationErrorMessage: { authorityMismatch: { code: string, desc: string }, authorityUriInsecure: { code: string, desc: string }, cannotAllowPlatformBroker: { code: string, desc: string }, cannotSetOIDCOptions: { code: string, desc: string }, claimsRequestParsingError: { code: string, desc: string }, emptyScopesError: { code: string, desc: string }, invalidAuthenticationHeader: { code: string, desc: string }, invalidAuthorityMetadata: { code: string, desc: string }, invalidAuthorizePostBodyParameters: { code: string, desc: string }, invalidClaimsRequest: { code: string, desc: string }, invalidCloudDiscoveryMetadata: { code: string, desc: string }, invalidCodeChallengeMethod: { code: string, desc: string }, invalidCodeChallengeParams: { code: string, desc: string }, invalidPlatformBrokerConfiguration: { code: string, desc: string }, invalidRequestMethodForEAR: { code: string, desc: string }, logoutRequestEmptyError: { code: string, desc: string }, missingNonceAuthenticationHeader: { code: string, desc: string }, missingSshJwk: { code: string, desc: string }, missingSshKid: { code: string, desc: string }, redirectUriNotSet: { code: string, desc: string }, tokenRequestEmptyError: { code: string, desc: string }, untrustedAuthority: { code: string, desc: string }, urlEmptyError: { code: string, desc: string }, urlParseError: { code: string, desc: string } }
Typ
{ authorityMismatch: { code: string, desc: string }, authorityUriInsecure: { code: string, desc: string }, cannotAllowPlatformBroker: { code: string, desc: string }, cannotSetOIDCOptions: { code: string, desc: string }, claimsRequestParsingError: { code: string, desc: string }, emptyScopesError: { code: string, desc: string }, invalidAuthenticationHeader: { code: string, desc: string }, invalidAuthorityMetadata: { code: string, desc: string }, invalidAuthorizePostBodyParameters: { code: string, desc: string }, invalidClaimsRequest: { code: string, desc: string }, invalidCloudDiscoveryMetadata: { code: string, desc: string }, invalidCodeChallengeMethod: { code: string, desc: string }, invalidCodeChallengeParams: { code: string, desc: string }, invalidPlatformBrokerConfiguration: { code: string, desc: string }, invalidRequestMethodForEAR: { code: string, desc: string }, logoutRequestEmptyError: { code: string, desc: string }, missingNonceAuthenticationHeader: { code: string, desc: string }, missingSshJwk: { code: string, desc: string }, missingSshKid: { code: string, desc: string }, redirectUriNotSet: { code: string, desc: string }, tokenRequestEmptyError: { code: string, desc: string }, untrustedAuthority: { code: string, desc: string }, urlEmptyError: { code: string, desc: string }, urlParseError: { code: string, desc: string } }
InteractionRequiredAuthErrorMessage
Warnung
Diese API ist nun veraltet.
Use InteractionRequiredAuthErrorCodes instead
Vom SDK definierte Fehler bei der Interaktion
InteractionRequiredAuthErrorMessage: { bad_token: { code: string, desc: string }, interrupted_user: { code: string, desc: string }, native_account_unavailable: { code: string, desc: string }, noTokensFoundError: { code: string, desc: string } }
Typ
{ bad_token: { code: string, desc: string }, interrupted_user: { code: string, desc: string }, native_account_unavailable: { code: string, desc: string }, noTokensFoundError: { code: string, desc: string } }
PromptValue
wir haben diese "Enumeration" in der Anforderung anstelle von Zeichenfolgen festgelegt, es sieht jedoch so aus, als ob die Liste der zulässigen Eingabeaufforderungswerte in den letzten Jahren geändert wurde. Es gibt auch einige nicht dokumentierte Eingabeaufforderungswerte für einige interne Partner, daher die Wahl des generischen "string"-Typs anstelle der "Enumeration"
PromptValue: { CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }
Typ
{ CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }
version
version: "3.8.10"
Typ
"3.8.10"