@azure/msal-browser package
Klassen
| AuthError |
Allgemeine Fehlerklasse, die von der MSAL.js Bibliothek ausgelöst wird. |
| AuthenticationHeaderParser |
Dies ist eine Hilfsklasse, die unterstützte HTTP-Antwortauthentifizierungsheader analysiert, um Abfragewerte für Header zu extrahieren und zurückzugeben, die außerhalb der grundlegenden Autorisierungsflüsse verwendet werden können. |
| BrowserAuthError |
Fehlerklasse der Browserbibliothek, die von der MSAL.js-Bibliothek für SPAs ausgelöst wird |
| BrowserConfigurationAuthError |
Fehlerklasse der Browserbibliothek, die von der MSAL.js-Bibliothek für SPAs ausgelöst wird |
| BrowserPerformanceClient | |
| BrowserPerformanceMeasurement | |
| 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. |
| EventHandler | |
| EventMessageUtils | |
| InteractionRequiredAuthError |
Fehler, der ausgelöst wird, wenn eine Benutzerinteraktion erforderlich ist. |
| LocalStorage | |
| Logger |
Klasse, die die Protokollierung von Nachrichten an einem bestimmten Ort erleichtert. |
| MemoryStorage | |
| NavigationClient | |
| PublicClientApplication |
Die PublicClientApplication-Klasse ist das Objekt, das von der Bibliothek verfügbar gemacht wird, um Authentifizierungs- und Autorisierungsfunktionen in Einzelseitenanwendungen auszuführen, um JWT-Token abzurufen, wie im OAuth 2.0-Autorisierungscodefluss mit PKCE-Spezifikation beschrieben. |
| PublicClientNext |
PublicClientNext ist ein frühzeitiger Blick auf die geplante Implementierung von PublicClientApplication in der nächsten Hauptversion von MSAL.js. Sie enthält Unterstützung für mehrere API-Implementierungen basierend auf der Laufzeitumgebung, in der sie ausgeführt wird. Die Ziele dieser Änderungen sind, eine klare Trennung des Verhaltens zwischen verschiedenen Betriebskontexten (nested App Auth, Platform Brokers, Plain old Browser usw.) bereitzustellen und gleichzeitig eine konsistente API-Oberfläche für Entwickler bereitzustellen. Verwenden Sie PublicClientApplication für alle Prod/Real-World-Szenarien. Hinweis: PublicClientNext ist experimentell und unterliegt unterbrechungspflichtigen Änderungen ohne folgende Semver |
| ServerError |
Fehler, der ausgelöst wird, wenn ein Fehler mit dem Servercode auftritt, z. B. nicht verfügbar. |
| SessionStorage | |
| SignedHttpRequest | |
| StubPerformanceClient | |
| UrlString |
Url-Objektklasse, die verschiedene Transformationen für URL-Zeichenfolgen ausführen kann. |
| AuthFlowActionRequiredStateBase |
Basisklasse für den Zustand der Aktion in einem Authentifizierungsfluss. |
| AuthFlowStateBase |
Basisklasse für den Status eines Authentifizierungsflusses. |
| AuthMethodRegistrationChallengeMethodError |
Fehler, der während der Abfrageanforderung für die Authentifizierungsmethode aufgetreten ist. |
| AuthMethodRegistrationChallengeMethodResult |
Ergebnis einer Herausforderung einer Authentifizierungsmethode für die Registrierung. Verwendet den Basiszustandstyp, um Zirkelabhängigkeiten zu vermeiden. |
| AuthMethodRegistrationCompletedState |
Status, der angibt, dass der Registrierungsfluss der Authentifizierungsmethode erfolgreich abgeschlossen wurde. |
| AuthMethodRegistrationFailedState |
Status, der angibt, dass der Registrierungsfluss der Authentifizierungsmethode fehlgeschlagen ist. |
| AuthMethodRegistrationRequiredState |
Status, der angibt, dass die Registrierung der Authentifizierungsmethode erforderlich ist. |
| AuthMethodRegistrationSubmitChallengeError |
Fehler, der bei der Übermittlung der Authentifizierungsmethode zur Abfrage aufgetreten ist. |
| AuthMethodRegistrationSubmitChallengeResult |
Ergebnis der Übermittlung einer Abfrage für die Registrierung von Authentifizierungsmethoden. |
| AuthMethodVerificationRequiredState |
Status, der angibt, dass die Überprüfung für die abfragebasierte Authentifizierungsmethode erforderlich ist. |
| CustomAuthAccountData | |
| CustomAuthApiError |
Fehler der benutzerdefinierten Authentifizierungs-API. |
| CustomAuthError | |
| CustomAuthPublicClientApplication | |
| GetAccessTokenResult | |
| GetAccountError |
Die Fehlerklasse zum Abrufen von Kontofehlern. |
| GetAccountResult | |
| GetCurrentAccountAccessTokenError |
Die Fehlerklasse zum Abrufen der Zugriffstokenfehler des aktuellen Kontos. |
| HttpError | |
| InvalidArgumentError | |
| InvalidConfigurationError | |
| MethodNotImplementedError | |
| MfaAwaitingState |
Status, der angibt, dass MFA erforderlich ist und auf die Benutzeraktion wartet. Dieser Zustand ermöglicht es dem Entwickler, die Ausführung anzuhalten, bevor der Code an die E-Mail des Benutzers gesendet wird. |
| MfaCompletedState |
Status, der angibt, dass der MFA-Fluss erfolgreich abgeschlossen wurde. |
| MfaFailedState |
Status, der angibt, dass der MFA-Fluss fehlgeschlagen ist. |
| MfaRequestChallengeError |
Fehler, der während der MFA-Abfrageanforderung aufgetreten ist. |
| MfaRequestChallengeResult |
Ergebnis der Anforderung einer MFA-Abfrage. Verwendet den Basiszustandstyp, um Zirkelabhängigkeiten zu vermeiden. |
| MfaSubmitChallengeError |
Fehler, der während der MFA-Abfrageübermittlung aufgetreten ist. |
| MfaSubmitChallengeResult |
Ergebnis der Einreichung einer MFA-Herausforderung. |
| MfaVerificationRequiredState |
Status, der angibt, dass die MFA-Überprüfung erforderlich ist. Die Herausforderung wurde gesendet, und der Benutzer muss den Code bereitstellen. |
| MsalCustomAuthError | |
| NoCachedAccountFoundError | |
| ParsedUrlError | |
| ResetPasswordCodeRequiredState |
Basisklasse für den Zustand der Aktion in einem Authentifizierungsfluss. |
| ResetPasswordCompletedState |
Stellt den Zustand dar, der den erfolgreichen Abschluss eines Kennwortzurücksetzungsvorgangs angibt. |
| ResetPasswordError | |
| ResetPasswordFailedState |
Status eines Kennwortzurücksetzungsvorgangs, der fehlgeschlagen ist. |
| ResetPasswordPasswordRequiredState |
Basisklasse für den Zustand der Aktion in einem Authentifizierungsfluss. |
| ResetPasswordResendCodeError | |
| ResetPasswordResendCodeResult | |
| ResetPasswordStartResult | |
| ResetPasswordState |
Basisklasse für den Zustand der Aktion in einem Authentifizierungsfluss. |
| ResetPasswordSubmitCodeError | |
| ResetPasswordSubmitCodeResult | |
| ResetPasswordSubmitPasswordError | |
| ResetPasswordSubmitPasswordResult | |
| SignInCodeRequiredState |
Basisklasse für den Zustand der Aktion in einem Authentifizierungsfluss. |
| SignInCompletedState |
Stellt den abgeschlossenen Status des Anmeldevorgangs dar. Dieser Zustand gibt an, dass der Anmeldevorgang erfolgreich abgeschlossen wurde. |
| SignInContinuationState |
Basisklasse für den Zustand der Aktion in einem Authentifizierungsfluss. |
| SignInError | |
| SignInFailedState |
Stellt den Status eines Anmeldevorgangs dar, der fehlgeschlagen ist. |
| SignInPasswordRequiredState |
Basisklasse für den Zustand der Aktion in einem Authentifizierungsfluss. |
| SignInResendCodeError | |
| SignInResendCodeResult | |
| SignInResult | |
| SignInState |
Basisklasse für den Zustand der Aktion in einem Authentifizierungsfluss. |
| SignInSubmitCodeError | |
| SignInSubmitCodeResult | |
| SignInSubmitPasswordError | |
| SignInSubmitPasswordResult | |
| SignOutError |
Die Fehlerklasse für Abmeldefehler. |
| SignOutResult | |
| SignUpAttributesRequiredState |
Basisklasse für den Zustand der Aktion in einem Authentifizierungsfluss. |
| SignUpCodeRequiredState |
Basisklasse für den Zustand der Aktion in einem Authentifizierungsfluss. |
| SignUpCompletedState |
Stellt den Status eines Registrierungsvorgangs dar, der erfolgreich abgeschlossen wurde. |
| SignUpError | |
| SignUpFailedState |
Stellt den Status eines Registrierungsvorgangs dar, der fehlgeschlagen ist. |
| SignUpPasswordRequiredState |
Basisklasse für den Zustand der Aktion in einem Authentifizierungsfluss. |
| SignUpResendCodeError | |
| SignUpResendCodeResult | |
| SignUpResult | |
| SignUpState |
Basisklasse für den Zustand der Aktion in einem Authentifizierungsfluss. |
| SignUpSubmitAttributesError | |
| SignUpSubmitAttributesResult | |
| SignUpSubmitCodeError | |
| SignUpSubmitCodeResult | |
| SignUpSubmitPasswordError | |
| SignUpSubmitPasswordResult | |
| UnexpectedError | |
| UnsupportedEnvironmentError | |
| UserAccountAttributeError | |
| UserAlreadySignedInError | |
Schnittstellen
| IController | |
| ILoggerCallback | |
| INavigationClient | |
| INetworkModule |
Clientnetzwerkschnittstelle zum Senden von Back-End-Anforderungen. |
| IPerformanceClient | |
| IPublicClientApplication | |
| ITokenCache | |
| IWindowStorage | |
| AuthMethodDetails |
Details zur Registrierung einer Authentifizierungsmethode. |
| AuthenticationMethod | |
| ICustomAuthPublicClientApplication | |
Typaliase
| AccountInfo |
Account-Objekt mit der folgenden Signatur:
|
| AuthenticationResult | |
| AuthorizationCodeRequest | |
| AuthorizationUrlRequest |
Dieser Typ ist veraltet und wird beim nächsten Hauptversionsupdate entfernt. |
| AzureCloudOptions |
Spezifische AzureCloudInstance-Optionen
|
| BrokerConnectionEvent |
Nutzlast für das BrokerConnectionEstablished-Ereignis |
| BrowserAuthOptions |
Verwenden Sie diese Option, um die Authentifizierungsoptionen im Configuration-Objekt zu konfigurieren. |
| BrowserSystemOptions | |
| BrowserTelemetryOptions |
Telemetrieoptionen |
| CacheOptions |
Verwenden Sie diese Option, um die folgenden Cachekonfigurationsoptionen zu konfigurieren: |
| ClearCacheRequest |
ClearCacheRequest
|
| Configuration |
Mit diesem Objekt können Sie wichtige Elemente der MSAL-Funktionalität konfigurieren und an den Konstruktor von PublicClientApplication übergeben werden. |
| EndSessionPopupRequest |
EndSessionPopupRequest
|
| EndSessionRequest |
EndSessionRequest
|
| EventCallbackFunction | |
| EventError | |
| EventMessage | |
| EventPayload | |
| ExternalTokenResponse |
Antwortobjekt, das zum Laden externer Token zum Cache verwendet wird.
|
| IdTokenClaims |
Typ, der ID-Tokenansprüche beschreibt, die von MSAL bekannt sind. |
| InProgressPerformanceEvent | |
| InitializeApplicationRequest |
InitializeApplicationRequest: Vom Benutzer übergebenes Anforderungsobjekt zum Initialisieren der Anwendung
|
| LoadTokenOptions | |
| NavigationOptions |
Zusätzliche Informationen, die an die NavigateInternal- und navigateExternal-Funktionen übergeben werden |
| NetworkRequestOptions |
Optionen, die von Netzwerkanforderungs-APIs zulässig sind. |
| NetworkResponse | |
| PerformanceCallbackFunction | |
| PerformanceEvent |
Leistungsmessung der Bibliothek, einschließlich Metadaten zur Anforderung und Anwendung. |
| PopupEvent | |
| PopupPosition | |
| PopupRequest |
PopupRequest: Anforderungsobjekt, das vom Benutzer übergeben wird, um einen Code vom Server (First Leg of Authorization Code Grant Flow) mit einem Popupfenster abzurufen.
|
| PopupSize | |
| PopupWindowAttributes |
Popupkonfigurationen zum Festlegen von Abmessungen und Position des Popupfensters |
| RedirectRequest |
RedirectRequest: Anforderungsobjekt, das vom Benutzer übergeben wird, um einen Code vom Server (first leg of authorization code grant flow) mit einer vollständigen Seitenumleitung abzurufen.
|
| SignedHttpRequestOptions | |
| SilentRequest |
SilentRequest: Anforderungsobjekt, das vom Benutzer übergeben wird, um Token aus dem Cache abzurufen, ein abgelaufenes Token mit einem Aktualisierungstoken zu erneuern oder einen Code (erster Teil des Autorisierungscode-Genehmigungsflusses) in einem ausgeblendeten iframe abzurufen.
|
| SsoSilentRequest |
Anforderungsobjekt, das vom Benutzer an ssoSilent übergeben wird, um einen Code vom Server abzurufen (First Leg of Authorization Code Grant Flow)
|
| TenantProfile |
Kontodetails, die für denselben Benutzer unterschiedlich sind |
| AccessTokenRetrievalInputs | |
| AccountRetrievalInputs | |
| AuthMethodRegistrationChallengeMethodResultState |
Typdefinition für mögliche AuthMethodRegistrationChallengeMethodResult. |
| AuthMethodRegistrationSubmitChallengeResultState |
Typdefinition für mögliche AuthMethodRegistrationSubmitChallengeResult. |
| CustomAuthConfiguration | |
| GetAccessTokenResultState |
Die möglichen Zustände für das GetAccessTokenResult. Dazu gehören:
|
| GetAccountResultState |
Die möglichen Zustände für das GetAccountResult. Dazu gehören:
|
| MfaRequestChallengeResultState |
Die möglichen Zustände für das MfaRequestChallengeResult. Dazu gehören:
|
| MfaSubmitChallengeResultState | |
| ResetPasswordInputs | |
| ResetPasswordResendCodeResultState |
Die möglichen Zustände für das ResetPasswordResendCodeResult. Dazu gehören:
|
| ResetPasswordStartResultState |
Die möglichen Zustände für das ResetPasswordStartResult. Dazu gehören:
|
| ResetPasswordSubmitCodeResultState |
Die möglichen Zustände für das ResetPasswordSubmitCodeResult. Dazu gehören:
|
| ResetPasswordSubmitPasswordResultState |
Die möglichen Zustände für "ResetPasswordSubmitPasswordResult". Dazu gehören:
|
| SignInInputs | |
| SignInResendCodeResultState |
Die möglichen Zustände für SignInResendCodeResult. Dazu gehören:
|
| SignInResultState |
Die möglichen Zustände für signInResult. Dazu gehören:
|
| SignInSubmitCodeResultState |
Die möglichen Zustände des SignInSubmitCodeResult. Dazu gehören:
|
| SignInSubmitPasswordResultState |
Die möglichen Zustände des SignInSubmitPasswordResult. Dazu gehören:
|
| SignInWithContinuationTokenInputs | |
| SignOutResultState |
Die möglichen Zustände für signOutResult. Dazu gehören:
|
| SignUpInputs | |
| SignUpResendCodeResultState |
Die möglichen Zustände für signUpResendCodeResult. Dazu gehören:
|
| SignUpResultState |
Die möglichen Status für das SignUpResult. Dazu gehören:
|
| SignUpSubmitAttributesResultState |
Die möglichen Zustände für signUpSubmitAttributesResult. Dazu gehören:
|
| SignUpSubmitCodeResultState |
Die möglichen Zustände für signUpSubmitCodeResult. Dazu gehören:
|
| SignUpSubmitPasswordResultState |
Die möglichen Zustände für signUpSubmitPasswordResult. Dazu gehören:
|
| UserAccountAttributes | |
Enumerationen
| InteractionType | |
| PerformanceEvents |
Aufzählung von Vorgängen, die durch ihre Leistung vom PerformanceClient gemessen werden. |
| LogLevel |
Protokollnachrichtenebene. |
Functions
| create |
erstellt NestedAppAuthController und übergibt ihn an die PublicClientApplication, fällt auf StandardController zurück, wenn NestedAppAuthController nicht verfügbar ist. |
| create |
erstellt PublicClientApplication mit StandardController |
| is |
Überprüft, ob der Plattformbroker in der aktuellen Umgebung verfügbar ist. |
Variablen
| Api |
API-Codes für Telemetriezwecke. 0-99 Silent Flow 800-899 Auth-Codefluss 900-999 Verschiedenes |
| Authentication |
Typ der Authentifizierungsanforderung |
| Azure |
|
| Browser |
|
| Cache |
|
| Event |
|
| Interaction |
Interaktionstypen, die derzeit ausgeführt werden. Wird in Ereignissen in Wrapperbibliotheken verwendet, um Funktionen aufzurufen, wenn bestimmte Interaktionen ausgeführt werden oder alle Interaktionen abgeschlossen sind. |
| Json |
|
| Protocol |
Von MSAL unterstützte Protokollmodi. |
| Server |
Zulässige Werte für den Serverantworttyp |
| WrapperSKU | |
| Auth |
AuthErrorMessage-Klasse mit Zeichenfolgenkonstanten, die von Fehlercodes und Nachrichten verwendet werden. |
| Browser |
BrowserAuthErrorMessage-Klasse mit Zeichenfolgenkonstanten, die von Fehlercodes und Nachrichten verwendet werden. |
| Browser |
BrowserAuthErrorMessage-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. |
| DEFAULT_IFRAME_TIMEOUT_MS | |
| Interaction |
Vom SDK definierte Fehler bei der Interaktion |
| OIDC_DEFAULT_SCOPES | |
| 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" |
| stubbed |
|
| version |
Details zur Funktion
createNestablePublicClientApplication(Configuration)
erstellt NestedAppAuthController und übergibt ihn an die PublicClientApplication, fällt auf StandardController zurück, wenn NestedAppAuthController nicht verfügbar ist.
function createNestablePublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>
Parameter
- configuration
- Configuration
Gibt zurück
Promise<IPublicClientApplication>
IPublicClientApplication
createStandardPublicClientApplication(Configuration)
erstellt PublicClientApplication mit StandardController
function createStandardPublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>
Parameter
- configuration
- Configuration
Gibt zurück
Promise<IPublicClientApplication>
IPublicClientApplication
isPlatformBrokerAvailable(LoggerOptions, IPerformanceClient, string, boolean)
Überprüft, ob der Plattformbroker in der aktuellen Umgebung verfügbar ist.
function isPlatformBrokerAvailable(loggerOptions?: LoggerOptions, perfClient?: IPerformanceClient, correlationId?: string, domConfig?: boolean): Promise<boolean>
Parameter
- loggerOptions
- LoggerOptions
- perfClient
- IPerformanceClient
- correlationId
-
string
- domConfig
-
boolean
Gibt zurück
Promise<boolean>
Details zu Variablen
ApiId
API-Codes für Telemetriezwecke. 0-99 Silent Flow 800-899 Auth-Codefluss 900-999 Verschiedenes
ApiId: { acquireTokenByCode: 866, acquireTokenPopup: 862, acquireTokenRedirect: 861, acquireTokenSilent_authCode: 864, acquireTokenSilent_silentFlow: 61, handleRedirectPromise: 865, hydrateCache: 963, loadExternalTokens: 964, logout: 961, logoutPopup: 962, ssoSilent: 863 }
Typ
{ acquireTokenByCode: 866, acquireTokenPopup: 862, acquireTokenRedirect: 861, acquireTokenSilent_authCode: 864, acquireTokenSilent_silentFlow: 61, handleRedirectPromise: 865, hydrateCache: 963, loadExternalTokens: 964, logout: 961, logoutPopup: 962, ssoSilent: 863 }
AuthenticationScheme
Typ der Authentifizierungsanforderung
AuthenticationScheme: { BEARER: "Bearer", POP: "pop", SSH: "ssh-cert" }
Typ
{ BEARER: "Bearer", POP: "pop", SSH: "ssh-cert" }
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" }
BrowserCacheLocation
BrowserCacheLocation: { LocalStorage: "localStorage", MemoryStorage: "memoryStorage", SessionStorage: "sessionStorage" }
Typ
{ LocalStorage: "localStorage", MemoryStorage: "memoryStorage", SessionStorage: "sessionStorage" }
CacheLookupPolicy
CacheLookupPolicy: { AccessToken: 1, AccessTokenAndRefreshToken: 2, Default: 0, RefreshToken: 3, RefreshTokenAndNetwork: 4, Skip: 5 }
Typ
{ AccessToken: 1, AccessTokenAndRefreshToken: 2, Default: 0, RefreshToken: 3, RefreshTokenAndNetwork: 4, Skip: 5 }
EventType
EventType: { ACCOUNT_ADDED: "msal:accountAdded", ACCOUNT_REMOVED: "msal:accountRemoved", ACQUIRE_TOKEN_BY_CODE_FAILURE: "msal:acquireTokenByCodeFailure", ACQUIRE_TOKEN_BY_CODE_START: "msal:acquireTokenByCodeStart", ACQUIRE_TOKEN_BY_CODE_SUCCESS: "msal:acquireTokenByCodeSuccess", ACQUIRE_TOKEN_FAILURE: "msal:acquireTokenFailure", ACQUIRE_TOKEN_NETWORK_START: "msal:acquireTokenFromNetworkStart", ACQUIRE_TOKEN_START: "msal:acquireTokenStart", ACQUIRE_TOKEN_SUCCESS: "msal:acquireTokenSuccess", ACTIVE_ACCOUNT_CHANGED: "msal:activeAccountChanged", BROKER_CONNECTION_ESTABLISHED: "msal:brokerConnectionEstablished", HANDLE_REDIRECT_END: "msal:handleRedirectEnd", HANDLE_REDIRECT_START: "msal:handleRedirectStart", INITIALIZE_END: "msal:initializeEnd", INITIALIZE_START: "msal:initializeStart", LOGIN_FAILURE: "msal:loginFailure", LOGIN_START: "msal:loginStart", LOGIN_SUCCESS: "msal:loginSuccess", LOGOUT_END: "msal:logoutEnd", LOGOUT_FAILURE: "msal:logoutFailure", LOGOUT_START: "msal:logoutStart", LOGOUT_SUCCESS: "msal:logoutSuccess", POPUP_OPENED: "msal:popupOpened", RESTORE_FROM_BFCACHE: "msal:restoreFromBFCache", SSO_SILENT_FAILURE: "msal:ssoSilentFailure", SSO_SILENT_START: "msal:ssoSilentStart", SSO_SILENT_SUCCESS: "msal:ssoSilentSuccess" }
Typ
{ ACCOUNT_ADDED: "msal:accountAdded", ACCOUNT_REMOVED: "msal:accountRemoved", ACQUIRE_TOKEN_BY_CODE_FAILURE: "msal:acquireTokenByCodeFailure", ACQUIRE_TOKEN_BY_CODE_START: "msal:acquireTokenByCodeStart", ACQUIRE_TOKEN_BY_CODE_SUCCESS: "msal:acquireTokenByCodeSuccess", ACQUIRE_TOKEN_FAILURE: "msal:acquireTokenFailure", ACQUIRE_TOKEN_NETWORK_START: "msal:acquireTokenFromNetworkStart", ACQUIRE_TOKEN_START: "msal:acquireTokenStart", ACQUIRE_TOKEN_SUCCESS: "msal:acquireTokenSuccess", ACTIVE_ACCOUNT_CHANGED: "msal:activeAccountChanged", BROKER_CONNECTION_ESTABLISHED: "msal:brokerConnectionEstablished", HANDLE_REDIRECT_END: "msal:handleRedirectEnd", HANDLE_REDIRECT_START: "msal:handleRedirectStart", INITIALIZE_END: "msal:initializeEnd", INITIALIZE_START: "msal:initializeStart", LOGIN_FAILURE: "msal:loginFailure", LOGIN_START: "msal:loginStart", LOGIN_SUCCESS: "msal:loginSuccess", LOGOUT_END: "msal:logoutEnd", LOGOUT_FAILURE: "msal:logoutFailure", LOGOUT_START: "msal:logoutStart", LOGOUT_SUCCESS: "msal:logoutSuccess", POPUP_OPENED: "msal:popupOpened", RESTORE_FROM_BFCACHE: "msal:restoreFromBFCache", SSO_SILENT_FAILURE: "msal:ssoSilentFailure", SSO_SILENT_START: "msal:ssoSilentStart", SSO_SILENT_SUCCESS: "msal:ssoSilentSuccess" }
InteractionStatus
Interaktionstypen, die derzeit ausgeführt werden. Wird in Ereignissen in Wrapperbibliotheken verwendet, um Funktionen aufzurufen, wenn bestimmte Interaktionen ausgeführt werden oder alle Interaktionen abgeschlossen sind.
InteractionStatus: { AcquireToken: "acquireToken", HandleRedirect: "handleRedirect", Login: "login", Logout: "logout", None: "none", SsoSilent: "ssoSilent", Startup: "startup" }
Typ
{ AcquireToken: "acquireToken", HandleRedirect: "handleRedirect", Login: "login", Logout: "logout", None: "none", SsoSilent: "ssoSilent", Startup: "startup" }
JsonWebTokenTypes
JsonWebTokenTypes: { Jwk: "JWK", Jwt: "JWT", Pop: "pop" }
Typ
{ Jwk: "JWK", Jwt: "JWT", Pop: "pop" }
ProtocolMode
Von MSAL unterstützte Protokollmodi.
ProtocolMode: { AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }
Typ
{ AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }
ServerResponseType
Warnung
Diese API ist nun veraltet.
Use ResponseMode instead
Zulässige Werte für den Serverantworttyp
ServerResponseType: { FRAGMENT: "fragment", QUERY: "query" }
Typ
{ FRAGMENT: "fragment", QUERY: "query" }
WrapperSKU
WrapperSKU: { Angular: "@azure/msal-angular", React: "@azure/msal-react" }
Typ
{ Angular: "@azure/msal-angular", React: "@azure/msal-react" }
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 } }
BrowserAuthErrorMessage
Warnung
Diese API ist nun veraltet.
Use exported BrowserAuthErrorCodes instead. In your app you can do :
import { BrowserAuthErrorCodes } from "@azure/msal-browser";
BrowserAuthErrorMessage-Klasse mit Zeichenfolgenkonstanten, die von Fehlercodes und Nachrichten verwendet werden.
BrowserAuthErrorMessage: { authCodeOrNativeAccountRequired: { code: string, desc: string }, authCodeRequired: { code: string, desc: string }, authRequestNotSet: { code: string, desc: string }, blockAcquireTokenInPopupsError: { code: string, desc: string }, blockTokenRequestsInHiddenIframeError: { code: string, desc: string }, cryptoDoesNotExist: { code: string, desc: string }, databaseNotOpen: { code: string, desc: string }, databaseUnavailable: { code: string, desc: string }, emptyNavigateUriError: { code: string, desc: string }, emptyWindowError: { code: string, desc: string }, failedToParseNetworkResponse: { code: string, desc: string }, getRequestFailed: { code: string, desc: string }, hashDoesNotContainKnownPropertiesError: { code: string, desc: string }, hashDoesNotContainStateError: { code: string, desc: string }, hashEmptyError: { code: string, desc: string }, iframeClosedPrematurelyError: { code: string, desc: string }, interactionInProgress: { code: string, desc: string }, invalidBase64StringError: { code: string, desc: string }, invalidCacheType: { code: string, desc: string }, invalidPopTokenRequest: { code: string, desc: string }, monitorIframeTimeoutError: { code: string, desc: string }, monitorPopupTimeoutError: { code: string, desc: string }, nativeConnectionNotEstablished: { code: string, desc: string }, nativeExtensionNotInstalled: { code: string, desc: string }, nativeHandshakeTimeout: { code: string, desc: string }, nativePromptNotSupported: { code: string, desc: string }, noAccountError: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, noTokenRequestCacheError: { code: string, desc: string }, notInBrowserEnvironment: { code: string, desc: string }, pkceNotGenerated: { code: string, desc: string }, popupWindowError: { code: string, desc: string }, postRequestFailed: { code: string, desc: string }, redirectInIframeError: { code: string, desc: string }, signingKeyNotFoundInStorage: { code: string, desc: string }, silentLogoutUnsupportedError: { code: string, desc: string }, silentPromptValueError: { code: string, desc: string }, spaCodeAndNativeAccountPresent: { code: string, desc: string }, stateInteractionTypeMismatchError: { code: string, desc: string }, unableToAcquireTokenFromNativePlatform: { code: string, desc: string }, unableToLoadTokenError: { code: string, desc: string }, unableToParseStateError: { code: string, desc: string }, unableToParseTokenRequestCacheError: { code: string, desc: string }, uninitializedPublicClientApplication: { code: string, desc: string }, userCancelledError: { code: string, desc: string } }
Typ
{ authCodeOrNativeAccountRequired: { code: string, desc: string }, authCodeRequired: { code: string, desc: string }, authRequestNotSet: { code: string, desc: string }, blockAcquireTokenInPopupsError: { code: string, desc: string }, blockTokenRequestsInHiddenIframeError: { code: string, desc: string }, cryptoDoesNotExist: { code: string, desc: string }, databaseNotOpen: { code: string, desc: string }, databaseUnavailable: { code: string, desc: string }, emptyNavigateUriError: { code: string, desc: string }, emptyWindowError: { code: string, desc: string }, failedToParseNetworkResponse: { code: string, desc: string }, getRequestFailed: { code: string, desc: string }, hashDoesNotContainKnownPropertiesError: { code: string, desc: string }, hashDoesNotContainStateError: { code: string, desc: string }, hashEmptyError: { code: string, desc: string }, iframeClosedPrematurelyError: { code: string, desc: string }, interactionInProgress: { code: string, desc: string }, invalidBase64StringError: { code: string, desc: string }, invalidCacheType: { code: string, desc: string }, invalidPopTokenRequest: { code: string, desc: string }, monitorIframeTimeoutError: { code: string, desc: string }, monitorPopupTimeoutError: { code: string, desc: string }, nativeConnectionNotEstablished: { code: string, desc: string }, nativeExtensionNotInstalled: { code: string, desc: string }, nativeHandshakeTimeout: { code: string, desc: string }, nativePromptNotSupported: { code: string, desc: string }, noAccountError: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, noTokenRequestCacheError: { code: string, desc: string }, notInBrowserEnvironment: { code: string, desc: string }, pkceNotGenerated: { code: string, desc: string }, popupWindowError: { code: string, desc: string }, postRequestFailed: { code: string, desc: string }, redirectInIframeError: { code: string, desc: string }, signingKeyNotFoundInStorage: { code: string, desc: string }, silentLogoutUnsupportedError: { code: string, desc: string }, silentPromptValueError: { code: string, desc: string }, spaCodeAndNativeAccountPresent: { code: string, desc: string }, stateInteractionTypeMismatchError: { code: string, desc: string }, unableToAcquireTokenFromNativePlatform: { code: string, desc: string }, unableToLoadTokenError: { code: string, desc: string }, unableToParseStateError: { code: string, desc: string }, unableToParseTokenRequestCacheError: { code: string, desc: string }, uninitializedPublicClientApplication: { code: string, desc: string }, userCancelledError: { code: string, desc: string } }
BrowserConfigurationAuthErrorMessage
Warnung
Diese API ist nun veraltet.
Use BrowserAuthErrorCodes instead
BrowserAuthErrorMessage-Klasse mit Zeichenfolgenkonstanten, die von Fehlercodes und Nachrichten verwendet werden.
BrowserConfigurationAuthErrorMessage: { inMemRedirectUnavailable: { code: string, desc: string }, storageNotSupportedError: { code: string, desc: string }, stubPcaInstanceCalled: { code: string, desc: string } }
Typ
{ inMemRedirectUnavailable: { code: string, desc: string }, storageNotSupportedError: { code: string, desc: string }, stubPcaInstanceCalled: { 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 } }
DEFAULT_IFRAME_TIMEOUT_MS
DEFAULT_IFRAME_TIMEOUT_MS: 10000
Typ
10000
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 } }
OIDC_DEFAULT_SCOPES
OIDC_DEFAULT_SCOPES: string[]
Typ
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 }
stubbedPublicClientApplication
version
version: "4.30.0"
Typ
"4.30.0"