@azure/msal-browser package
Klasser
| AuthError |
Allmän felklass som genereras av biblioteket MSAL.js. |
| AuthenticationHeaderParser |
Det här är en hjälpklass som parsar http-svarsautentiseringshuvuden som stöds för att extrahera och returnera huvudutmaningsvärden som kan användas utanför de grundläggande auktoriseringsflödena. |
| BrowserAuthError |
Felklass för webbläsarbibliotek som genereras av MSAL.js-biblioteket för SPA:er |
| BrowserConfigurationAuthError |
Felklass för webbläsarbibliotek som genereras av MSAL.js-biblioteket för SPA:er |
| BrowserPerformanceClient | |
| BrowserPerformanceMeasurement | |
| ClientAuthError |
Ett fel uppstod när ett fel uppstod i klientkoden som körs i webbläsaren. |
| ClientConfigurationError |
Ett fel uppstod när det uppstod ett fel i konfigurationen av MSAL.js-biblioteket. |
| EventHandler | |
| EventMessageUtils | |
| InteractionRequiredAuthError |
Fel uppstod när användarinteraktion krävs. |
| LocalStorage | |
| Logger |
Klass som underlättar loggning av meddelanden till en viss plats. |
| MemoryStorage | |
| NavigationClient | |
| PublicClientApplication |
Klassen PublicClientApplication är objektet som exponeras av biblioteket för att utföra autentiserings- och auktoriseringsfunktioner i ensidesprogram för att hämta JWT-token enligt beskrivningen i OAuth 2.0 Authorization Code Flow med PKCE-specifikation. |
| PublicClientNext |
PublicClientNext är en tidig titt på den planerade implementeringen av PublicClientApplication i nästa huvudversion av MSAL.js. Den innehåller stöd för flera API-implementeringar baserat på den körningsmiljö som körs i. Syftet med dessa ändringar är att ge en ren uppdelning av beteendet mellan olika driftskontexter (kapslad appautentisering, plattformskoordinatorer, vanlig gammal webbläsare osv.) samtidigt som utvecklarna får en konsekvent API-yta. Använd PublicClientApplication för alla prod-/verkliga scenarier. Obs! PublicClientNext är experimentellt och kan komma att ändras utan att följa semver |
| ServerError |
Ett fel uppstod när det uppstod ett fel med serverkoden, till exempel otillgänglighet. |
| SessionStorage | |
| SignedHttpRequest | |
| StubPerformanceClient | |
| UrlString |
Url-objektklass som kan utföra olika transformeringar på URL-strängar. |
| AuthFlowActionRequiredStateBase |
Basklass för åtgärdens requried-tillstånd i ett autentiseringsflöde. |
| AuthFlowStateBase |
Basklass för tillståndet för ett autentiseringsflöde. |
| AuthMethodRegistrationChallengeMethodError |
Fel som uppstod under begäran om autentiseringsmetodutmaning. |
| AuthMethodRegistrationChallengeMethodResult |
Resultatet av att utmana en autentiseringsmetod för registrering. Använder bastillståndstyp för att undvika cirkulära beroenden. |
| AuthMethodRegistrationCompletedState |
Tillstånd som anger att registreringsflödet för autentiseringsmetoden har slutförts. |
| AuthMethodRegistrationFailedState |
Tillstånd som anger att registreringsflödet för autentiseringsmetoden har misslyckats. |
| AuthMethodRegistrationRequiredState |
Tillstånd som anger att registrering av autentiseringsmetod krävs. |
| AuthMethodRegistrationSubmitChallengeError |
Fel som inträffade under överföring av autentiseringsmetodutmaning. |
| AuthMethodRegistrationSubmitChallengeResult |
Resultatet av att skicka en utmaning för registrering av autentiseringsmetoder. |
| AuthMethodVerificationRequiredState |
Tillstånd som anger att verifiering krävs för den ifrågasatta autentiseringsmetoden. |
| CustomAuthAccountData | |
| CustomAuthApiError |
Api-fel för anpassad autentisering. |
| CustomAuthError | |
| CustomAuthPublicClientApplication | |
| GetAccessTokenResult | |
| GetAccountError |
Felklassen för att hämta kontofel. |
| GetAccountResult | |
| GetCurrentAccountAccessTokenError |
Felklassen för att hämta det aktuella kontots åtkomsttokenfel. |
| HttpError | |
| InvalidArgumentError | |
| InvalidConfigurationError | |
| MethodNotImplementedError | |
| MfaAwaitingState |
Tillstånd som anger att MFA krävs och väntar på användaråtgärd. Med det här tillståndet kan utvecklaren pausa körningen innan koden skickas till användarens e-post. |
| MfaCompletedState |
Tillstånd som anger att MFA-flödet har slutförts. |
| MfaFailedState |
Tillstånd som anger att MFA-flödet har misslyckats. |
| MfaRequestChallengeError |
Fel som uppstod under MFA-utmaningsbegäran. |
| MfaRequestChallengeResult |
Resultatet av att begära en MFA-utmaning. Använder bastillståndstyp för att undvika cirkulära beroenden. |
| MfaSubmitChallengeError |
Fel som uppstod under MFA-utmaningsöverföring. |
| MfaSubmitChallengeResult |
Resultatet av att skicka en MFA-utmaning. |
| MfaVerificationRequiredState |
Tillstånd som anger att MFA-verifiering krävs. Utmaningen har skickats och användaren måste ange koden. |
| MsalCustomAuthError | |
| NoCachedAccountFoundError | |
| ParsedUrlError | |
| ResetPasswordCodeRequiredState |
Basklass för åtgärdens requried-tillstånd i ett autentiseringsflöde. |
| ResetPasswordCompletedState |
Representerar tillståndet som anger att en lösenordsåterställningsåtgärd har slutförts. |
| ResetPasswordError | |
| ResetPasswordFailedState |
Tillståndet för en återställningslösenordsåtgärd som har misslyckats. |
| ResetPasswordPasswordRequiredState |
Basklass för åtgärdens requried-tillstånd i ett autentiseringsflöde. |
| ResetPasswordResendCodeError | |
| ResetPasswordResendCodeResult | |
| ResetPasswordStartResult | |
| ResetPasswordState |
Basklass för åtgärdens requried-tillstånd i ett autentiseringsflöde. |
| ResetPasswordSubmitCodeError | |
| ResetPasswordSubmitCodeResult | |
| ResetPasswordSubmitPasswordError | |
| ResetPasswordSubmitPasswordResult | |
| SignInCodeRequiredState |
Basklass för åtgärdens requried-tillstånd i ett autentiseringsflöde. |
| SignInCompletedState |
Representerar det slutförda tillståndet för inloggningsåtgärden. Det här tillståndet anger att inloggningsprocessen har slutförts. |
| SignInContinuationState |
Basklass för åtgärdens requried-tillstånd i ett autentiseringsflöde. |
| SignInError | |
| SignInFailedState |
Representerar tillståndet för en inloggningsåtgärd som har misslyckats. |
| SignInPasswordRequiredState |
Basklass för åtgärdens requried-tillstånd i ett autentiseringsflöde. |
| SignInResendCodeError | |
| SignInResendCodeResult | |
| SignInResult | |
| SignInState |
Basklass för åtgärdens requried-tillstånd i ett autentiseringsflöde. |
| SignInSubmitCodeError | |
| SignInSubmitCodeResult | |
| SignInSubmitPasswordError | |
| SignInSubmitPasswordResult | |
| SignOutError |
Felklassen för utloggningsfel. |
| SignOutResult | |
| SignUpAttributesRequiredState |
Basklass för åtgärdens requried-tillstånd i ett autentiseringsflöde. |
| SignUpCodeRequiredState |
Basklass för åtgärdens requried-tillstånd i ett autentiseringsflöde. |
| SignUpCompletedState |
Representerar tillståndet för en registreringsåtgärd som har slutförts. |
| SignUpError | |
| SignUpFailedState |
Representerar tillståndet för en registreringsåtgärd som har misslyckats. |
| SignUpPasswordRequiredState |
Basklass för åtgärdens requried-tillstånd i ett autentiseringsflöde. |
| SignUpResendCodeError | |
| SignUpResendCodeResult | |
| SignUpResult | |
| SignUpState |
Basklass för åtgärdens requried-tillstånd i ett autentiseringsflöde. |
| SignUpSubmitAttributesError | |
| SignUpSubmitAttributesResult | |
| SignUpSubmitCodeError | |
| SignUpSubmitCodeResult | |
| SignUpSubmitPasswordError | |
| SignUpSubmitPasswordResult | |
| UnexpectedError | |
| UnsupportedEnvironmentError | |
| UserAccountAttributeError | |
| UserAlreadySignedInError | |
Gränssnitt
| IController | |
| ILoggerCallback | |
| INavigationClient | |
| INetworkModule |
Klientnätverksgränssnitt för att skicka serverdelsbegäranden. |
| IPerformanceClient | |
| IPublicClientApplication | |
| ITokenCache | |
| IWindowStorage | |
| AuthMethodDetails |
Information om en autentiseringsmetod som ska registreras. |
| AuthenticationMethod | |
| ICustomAuthPublicClientApplication | |
Typalias
| AccountInfo |
Kontoobjekt med följande signatur:
|
| AuthenticationResult | |
| AuthorizationCodeRequest | |
| AuthorizationUrlRequest |
Den här typen är inaktuell och tas bort vid nästa huvudversionsuppdatering |
| AzureCloudOptions |
Specifika alternativ för AzureCloudInstance
|
| BrokerConnectionEvent |
Nyttolast för brokerConnectionEstablished-händelsen |
| BrowserAuthOptions |
Använd detta för att konfigurera autentiseringsalternativen i konfigurationsobjektet |
| BrowserSystemOptions | |
| BrowserTelemetryOptions |
Telemetrialternativ |
| CacheOptions |
Använd detta för att konfigurera konfigurationsalternativen för cachen nedan: |
| ClearCacheRequest |
ClearCacheRequest
|
| Configuration |
Med det här objektet kan du konfigurera viktiga element i MSAL-funktioner och skickas till konstruktorn för PublicClientApplication |
| EndSessionPopupRequest |
EndSessionPopupRequest
|
| EndSessionRequest |
EndSessionRequest
|
| EventCallbackFunction | |
| EventError | |
| EventMessage | |
| EventPayload | |
| ExternalTokenResponse |
Svarsobjekt som används för att läsa in externa token till cacheminnet.
|
| IdTokenClaims |
Typ som beskriver ID-tokenanspråk som är kända av MSAL. |
| InProgressPerformanceEvent | |
| InitializeApplicationRequest |
InitializeApplicationRequest: Begärandeobjekt som skickas av användaren för att initiera programmet
|
| LoadTokenOptions | |
| NavigationOptions |
Ytterligare information som skickas till funktionerna navigateInternal och navigateExternal |
| NetworkRequestOptions |
Alternativ som tillåts av API:er för nätverksbegäran. |
| NetworkResponse | |
| PerformanceCallbackFunction | |
| PerformanceEvent |
Prestandamätning som görs av biblioteket, inklusive metadata om begäran och programmet. |
| PopupEvent | |
| PopupPosition | |
| PopupRequest |
PopupRequest: Begär objekt som skickas av användaren för att hämta en kod från servern (första delen av auktoriseringskodens beviljandeflöde) med ett popup-fönster.
|
| PopupSize | |
| PopupWindowAttributes |
Popup-konfigurationer för att ange dimensioner och placering av popup-fönster |
| RedirectRequest |
RedirectRequest: Begär objekt som skickas av användaren för att hämta en kod från servern (första delen av auktoriseringskodens beviljandeflöde) med en fullständig sidomdirigering.
|
| SignedHttpRequestOptions | |
| SilentRequest |
SilentRequest: Begär objekt som skickas av användaren för att hämta token från cacheminnet, förnya en token som har upphört att gälla med en uppdateringstoken eller hämta en kod (första delen av auktoriseringskodens beviljandeflöde) i en dold iframe.
|
| SsoSilentRequest |
Begär objekt som skickas av användaren till ssoSilent för att hämta en kod från servern (första delen av auktoriseringskodens beviljandeflöde)
|
| TenantProfile |
Kontoinformation som varierar mellan klienter för samma användare |
| AccessTokenRetrievalInputs | |
| AccountRetrievalInputs | |
| AuthMethodRegistrationChallengeMethodResultState |
Typdefinition för möjliga tillstånd i AuthMethodRegistrationChallengeMethodResult. |
| AuthMethodRegistrationSubmitChallengeResultState |
Typdefinition för möjliga tillstånd i AuthMethodRegistrationSubmitChallengeResult. |
| CustomAuthConfiguration | |
| GetAccessTokenResultState |
Möjliga tillstånd för GetAccessTokenResult. Detta omfattar:
|
| GetAccountResultState |
Möjliga tillstånd för GetAccountResult. Detta omfattar:
|
| MfaRequestChallengeResultState |
Möjliga tillstånd för MfaRequestChallengeResult. Detta omfattar:
|
| MfaSubmitChallengeResultState | |
| ResetPasswordInputs | |
| ResetPasswordResendCodeResultState |
Möjliga tillstånd för ResetPasswordResendCodeResult. Detta omfattar:
|
| ResetPasswordStartResultState |
Möjliga tillstånd för ResetPasswordStartResult. Detta omfattar:
|
| ResetPasswordSubmitCodeResultState |
Möjliga tillstånd för ResetPasswordSubmitCodeResult. Detta omfattar:
|
| ResetPasswordSubmitPasswordResultState |
Möjliga tillstånd för ResetPasswordSubmitPasswordResult. Detta omfattar:
|
| SignInInputs | |
| SignInResendCodeResultState |
Möjliga tillstånd för SignInResendCodeResult. Detta omfattar:
|
| SignInResultState |
Möjliga tillstånd för SignInResult. Detta omfattar:
|
| SignInSubmitCodeResultState |
Möjliga tillstånd för SignInSubmitCodeResult. Detta omfattar:
|
| SignInSubmitPasswordResultState |
Möjliga tillstånd för SignInSubmitPasswordResult. Detta omfattar:
|
| SignInWithContinuationTokenInputs | |
| SignOutResultState |
Möjliga tillstånd för SignOutResult. Detta omfattar:
|
| SignUpInputs | |
| SignUpResendCodeResultState |
Möjliga tillstånd för SignUpResendCodeResult. Detta omfattar:
|
| SignUpResultState |
Möjliga tillstånd för SignUpResult. Detta omfattar:
|
| SignUpSubmitAttributesResultState |
Möjliga tillstånd för SignUpSubmitAttributesResult. Detta omfattar:
|
| SignUpSubmitCodeResultState |
Möjliga tillstånd för SignUpSubmitCodeResult. Detta omfattar:
|
| SignUpSubmitPasswordResultState |
Möjliga tillstånd för SignUpSubmitPasswordResult. Detta omfattar:
|
| UserAccountAttributes | |
Uppräkningar
| InteractionType | |
| PerformanceEvents |
Uppräkning av åtgärder som instrumenteras av får sina prestanda mätta med PerformanceClient. |
| LogLevel |
Loggmeddelandenivå. |
Funktioner
| create |
skapar NestedAppAuthController och skickar den till PublicClientApplication, återgår till StandardController om NestedAppAuthController inte är tillgänglig |
| create |
skapar PublicClientApplication med StandardController |
| is |
Kontrollerar om plattformskoordinatorn är tillgänglig i den aktuella miljön. |
Variabler
| Api |
API-koder för telemetriändamål. 0-99 Tyst flöde 800-899 Auth Code Flow 900-999 Diverse |
| Authentication |
Typ av autentiseringsbegäran |
| Azure |
|
| Browser |
|
| Cache |
|
| Event |
|
| Interaction |
Typer av interaktion som för närvarande pågår. Används i händelser i omslutningsbibliotek för att anropa funktioner när viss interaktion pågår eller alla interaktioner är slutförda. |
| Json |
|
| Protocol |
Protokolllägen som stöds av MSAL. |
| Server |
tillåtna värden för serversvarstyp |
| WrapperSKU | |
| Auth |
Klassen AuthErrorMessage innehåller strängkonstanter som används av felkoder och meddelanden. |
| Browser |
Klassen BrowserAuthErrorMessage innehåller strängkonstanter som används av felkoder och meddelanden. |
| Browser |
Klassen BrowserAuthErrorMessage innehåller strängkonstanter som används av felkoder och meddelanden. |
| Client |
Strängkonstanter som används av felkoder och meddelanden. |
| Client |
Klassen ClientConfigurationErrorMessage innehåller strängkonstanter som används av felkoder och meddelanden. |
| DEFAULT_IFRAME_TIMEOUT_MS | |
| Interaction |
Interaktionsfel som krävs som definieras av SDK |
| OIDC_DEFAULT_SCOPES | |
| Prompt |
Vi övervägde att göra den här "uppräkningen" i begäran i stället för strängen, men det ser ut som den tillåtna listan med promptvärden som har ändrats under de senaste åren. Det finns vissa odokumenterade promptvärden för vissa interna partner också, därav valet av generisk "sträng"-typ i stället för "uppräkning" |
| stubbed |
|
| version |
Funktionsinformation
createNestablePublicClientApplication(Configuration)
skapar NestedAppAuthController och skickar den till PublicClientApplication, återgår till StandardController om NestedAppAuthController inte är tillgänglig
function createNestablePublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>
Parametrar
- configuration
- Configuration
Returer
Promise<IPublicClientApplication>
IPublicClientApplication
createStandardPublicClientApplication(Configuration)
skapar PublicClientApplication med StandardController
function createStandardPublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>
Parametrar
- configuration
- Configuration
Returer
Promise<IPublicClientApplication>
IPublicClientApplication
isPlatformBrokerAvailable(LoggerOptions, IPerformanceClient, string, boolean)
Kontrollerar om plattformskoordinatorn är tillgänglig i den aktuella miljön.
function isPlatformBrokerAvailable(loggerOptions?: LoggerOptions, perfClient?: IPerformanceClient, correlationId?: string, domConfig?: boolean): Promise<boolean>
Parametrar
- loggerOptions
- LoggerOptions
- perfClient
- IPerformanceClient
- correlationId
-
string
- domConfig
-
boolean
Returer
Promise<boolean>
Variabelinformation
ApiId
API-koder för telemetriändamål. 0-99 Tyst flöde 800-899 Auth Code Flow 900-999 Diverse
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 av autentiseringsbegäran
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
Typer av interaktion som för närvarande pågår. Används i händelser i omslutningsbibliotek för att anropa funktioner när viss interaktion pågår eller alla interaktioner är slutförda.
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
Protokolllägen som stöds av MSAL.
ProtocolMode: { AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }
Typ
{ AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }
ServerResponseType
Varning
Det här API:et är nu inaktuellt.
Use ResponseMode instead
tillåtna värden för serversvarstyp
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
Varning
Det här API:et är nu inaktuellt.
Use AuthErrorCodes instead
Klassen AuthErrorMessage innehåller strängkonstanter som används av felkoder och meddelanden.
AuthErrorMessage: { postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }
Typ
{ postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }
BrowserAuthErrorMessage
Varning
Det här API:et är nu inaktuellt.
Use exported BrowserAuthErrorCodes instead. In your app you can do :
import { BrowserAuthErrorCodes } from "@azure/msal-browser";
Klassen BrowserAuthErrorMessage innehåller strängkonstanter som används av felkoder och meddelanden.
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
Varning
Det här API:et är nu inaktuellt.
Use BrowserAuthErrorCodes instead
Klassen BrowserAuthErrorMessage innehåller strängkonstanter som används av felkoder och meddelanden.
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
Varning
Det här API:et är nu inaktuellt.
Use ClientAuthErrorCodes instead
Strängkonstanter som används av felkoder och meddelanden.
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
Varning
Det här API:et är nu inaktuellt.
Use ClientConfigurationErrorCodes instead
Klassen ClientConfigurationErrorMessage innehåller strängkonstanter som används av felkoder och meddelanden.
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
Varning
Det här API:et är nu inaktuellt.
Use InteractionRequiredAuthErrorCodes instead
Interaktionsfel som krävs som definieras av SDK
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
Vi övervägde att göra den här "uppräkningen" i begäran i stället för strängen, men det ser ut som den tillåtna listan med promptvärden som har ändrats under de senaste åren. Det finns vissa odokumenterade promptvärden för vissa interna partner också, därav valet av generisk "sträng"-typ i stället för "uppräkning"
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"