@azure/msal-browser package

類別

AuthError

MSAL.js 函式庫拋出的一般錯誤類別。

AuthenticationHeaderParser

這是一個輔助類別,解析支援的 HTTP 回應認證標頭,以提取並回傳可用於基本授權流程之外的標頭挑戰值。

BrowserAuthError

MSAL.js 函式庫拋出的瀏覽器函式庫錯誤類別

BrowserConfigurationAuthError

MSAL.js 函式庫拋出的瀏覽器函式庫錯誤類別

BrowserPerformanceClient
BrowserPerformanceMeasurement
ClientAuthError

當瀏覽器執行的客戶端程式碼出現錯誤時,會跳出錯誤。

ClientConfigurationError

當 MSAL.js 函式庫設定錯誤時會拋出錯誤。

EventHandler
EventMessageUtils
InteractionRequiredAuthError

當需要使用者互動時會拋出錯誤。

LocalStorage
Logger

類別協助將訊息記錄到特定位置。

MemoryStorage
NavigationClient
PublicClientApplication

PublicClientApplication 類別是函式庫所揭露的物件,用於在單頁應用程式中執行認證與授權功能,以取得 JWT 令牌,這些功能依據 OAuth 2.0 授權碼流程與 PKCE 規範所描述。

PublicClientNext

PublicClientNext 是 PublicClientApplication 計畫在下一版 MSAL.js中實施的早期預覽。 它支援根據執行環境的多種 API 實作。

這些變更的目標是在不同操作情境(巢狀應用程式認證、平台代理、舊版瀏覽器等)之間,提供行為的乾淨分離,同時仍能為開發者提供一致的 API 介面。

請使用 PublicClientApplication 處理任何生產或實際場景。 注意:PublicClientNext 是實驗性質,若不遵循 semver 可能會有重大變更

ServerError

當伺服器程式碼出現錯誤時會拋出錯誤,例如無法使用。

SessionStorage
SignedHttpRequest
StubPerformanceClient
UrlString

URL 物件類別,可以對 URL 字串執行各種轉換。

AuthFlowActionRequiredStateBase

在認證流程中,作為動作需求狀態的基底類別。

AuthFlowStateBase

驗證流程狀態的基底類別。

AuthMethodRegistrationChallengeMethodError

驗證方法挑戰請求期間發生的錯誤。

AuthMethodRegistrationChallengeMethodResult

這是因為挑戰註冊認證方式而產生的結果。 使用基礎狀態型別以避免循環依賴。

AuthMethodRegistrationCompletedState

表示認證方法註冊流程已成功完成。

AuthMethodRegistrationFailedState

表示認證方法註冊流程失敗的狀態。

AuthMethodRegistrationRequiredState

表示需要註冊認證方法的狀態。

AuthMethodRegistrationSubmitChallengeError

在驗證方法挑戰提交過程中發生的錯誤。

AuthMethodRegistrationSubmitChallengeResult

提交驗證方法註冊挑戰的結果。

AuthMethodVerificationRequiredState

表示被質疑的認證方法需要驗證。

CustomAuthAccountData
CustomAuthApiError

自訂認證 API 錯誤。

CustomAuthError
CustomAuthPublicClientApplication
GetAccessTokenResult
GetAccountError

取得帳號錯誤的錯誤類別。

GetAccountResult
GetCurrentAccountAccessTokenError

是針對目前帳戶存取權杖錯誤的錯誤類別。

HttpError
InvalidArgumentError
InvalidConfigurationError
MethodNotImplementedError
MfaAwaitingState

說明需要多重認證並等待使用者採取行動。 此狀態允許開發者在將程式碼傳送至使用者電子郵件前暫停執行。

MfaCompletedState

表示MFA流程已成功完成。

MfaFailedState

表示 MFA 流程失敗的狀態。

MfaRequestChallengeError

MFA 挑戰請求時發生的錯誤。

MfaRequestChallengeResult

申請MFA挑戰的結果。 使用基礎狀態型別以避免循環依賴。

MfaSubmitChallengeError

提交多重認證挑戰時發生的錯誤。

MfaSubmitChallengeResult

提交MFA挑戰的結果。

MfaVerificationRequiredState

州政府表示需要進行多重身份驗證(MFA)。 挑戰已經寄出,使用者需要提供程式碼。

MsalCustomAuthError
NoCachedAccountFoundError
ParsedUrlError
ResetPasswordCodeRequiredState

在認證流程中,作為動作需求狀態的基底類別。

ResetPasswordCompletedState

代表代表密碼重設操作成功完成的狀態。

ResetPasswordError
ResetPasswordFailedState

重設密碼操作失敗的狀態。

ResetPasswordPasswordRequiredState

在認證流程中,作為動作需求狀態的基底類別。

ResetPasswordResendCodeError
ResetPasswordResendCodeResult
ResetPasswordStartResult
ResetPasswordState

在認證流程中,作為動作需求狀態的基底類別。

ResetPasswordSubmitCodeError
ResetPasswordSubmitCodeResult
ResetPasswordSubmitPasswordError
ResetPasswordSubmitPasswordResult
SignInCodeRequiredState

在認證流程中,作為動作需求狀態的基底類別。

SignInCompletedState

代表登入操作的完成狀態。 此狀態表示登入程序已成功完成。

SignInContinuationState

在認證流程中,作為動作需求狀態的基底類別。

SignInError
SignInFailedState

代表登入操作失敗的狀態。

SignInPasswordRequiredState

在認證流程中,作為動作需求狀態的基底類別。

SignInResendCodeError
SignInResendCodeResult
SignInResult
SignInState

在認證流程中,作為動作需求狀態的基底類別。

SignInSubmitCodeError
SignInSubmitCodeResult
SignInSubmitPasswordError
SignInSubmitPasswordResult
SignOutError

登出錯誤類別。

SignOutResult
SignUpAttributesRequiredState

在認證流程中,作為動作需求狀態的基底類別。

SignUpCodeRequiredState

在認證流程中,作為動作需求狀態的基底類別。

SignUpCompletedState

代表註冊作業已成功完成的狀態。

SignUpError
SignUpFailedState

代表註冊運作失敗的狀態。

SignUpPasswordRequiredState

在認證流程中,作為動作需求狀態的基底類別。

SignUpResendCodeError
SignUpResendCodeResult
SignUpResult
SignUpState

在認證流程中,作為動作需求狀態的基底類別。

SignUpSubmitAttributesError
SignUpSubmitAttributesResult
SignUpSubmitCodeError
SignUpSubmitCodeResult
SignUpSubmitPasswordError
SignUpSubmitPasswordResult
UnexpectedError
UnsupportedEnvironmentError
UserAccountAttributeError
UserAlreadySignedInError

類型別名

AccountInfo

帳號物件,簽名如下:

  • homeAccountId - 此帳戶物件的 Home account 識別碼
  • environment-發行由發行者域名代表的代幣的實體(例如 login.microsoftonline.com)
  • tenantId - 該帳號所屬的完整租戶或組織識別碼
  • 用戶名 - preferred_username代表此帳號的id_token聲稱
  • localAccountId - 本機、租戶專用的帳號識別碼,通常用於舊有案件
  • 姓名 - 帳戶的全名,包括名字和姓氏
  • idToken - 原始 ID 令牌
  • idTokenClaims - 物件包含來自 ID 憑證的聲明
  • nativeAccountId-使用者的原生帳號ID
  • tenantProfiles - 每個帳號在瀏覽器中驗證過的租戶資料物件映射
  • dataBoundary - 從 clientInfo 擷取的資料邊界
AuthenticationResult
AuthorizationCodeRequest
AuthorizationUrlRequest

此類型已被棄用,將於下一次重大版本更新中移除

AzureCloudOptions

AzureCloudInstance 專屬選項

  • azureCloudInstance - string enum 提供主權及公共雲權威的簡短符號
  • 租戶 - 提供租戶資訊的條款
BrokerConnectionEvent

BrokerConnectionEstablished 事件的有效載荷

BrowserAuthOptions

用這個來設定設定物件中的認證選項

BrowserSystemOptions
BrowserTelemetryOptions

遙測選項

CacheOptions

請使用此方法設定以下快取設定選項:

ClearCacheRequest

清除快取請求

  • correlationId - 每個請求唯一的 GUID 設定,用於遠端追蹤請求以進行遙測。
  • 帳號 - 將被登出的帳號物件。 所有綁定此帳戶的代幣都會被清算。
Configuration

此物件允許你配置 MSAL 功能的重要元素,並被傳遞到 PublicClientApplication 的建構子中

EndSessionPopupRequest

EndSessionPopupRequest

  • 帳號 - 將被登出的帳號物件。 所有綁定此帳戶的代幣都會被清算。
  • postLogoutRedirectUri - URI 用來在跳出視窗中導向登出後頁面。 必須確保彈出視窗能關閉。
  • 權限 - 發送登出請求的權限。
  • correlationId - 每個請求唯一的 GUID 設定,用於遠端追蹤請求以進行遙測。
  • idTokenHint - B2C 用於驗證登出的 ID 憑證(若政策要求)
  • mainWindowRedirectUri - URI 用於登出完成後導覽主視窗
  • popupWindowAttributes - 可選的彈出視窗屬性。 popupSize 可以設定高度和寬度,以及 popupPosition 的上下與左邊。
  • logoutHint - 一個字串,指定要登出的帳號,以便在登出時跳過伺服器帳號選擇器
  • popupWindowParent - 可選的視窗物件,當開啟彈出視窗時用作父視窗。 如果沒有給出,則使用全域 window
EndSessionRequest

結束會話請求

  • 帳號 - 將被登出的帳號物件。 所有綁定此帳戶的代幣都會被清算。
  • postLogoutRedirectUri - URI 可導航至登出後頁面。
  • 權限 - 發送登出請求的權限。
  • correlationId - 每個請求唯一的 GUID 設定,用於遠端追蹤請求以進行遙測。
  • idTokenHint - B2C 用於驗證登出的 ID 憑證(若政策要求)
  • onRedirectNavigate - 回調,將傳遞給 MSAL 所導航的網址。 回調時回傳 false 會停止導航。
  • logoutHint - 一個字串,指定要登出的帳號,以便在登出時跳過伺服器帳號選擇器
EventCallbackFunction
EventError
EventMessage
EventPayload
ExternalTokenResponse

用於將外部標記載入快取的回應物件。

  • token_type:表示代幣類型的價值。 Azure AD 唯一支援的類型是承載者。
  • 範圍:access_token有效範圍內的範圍。
  • expires_in:存取權杖有效時間(以秒計)。
  • id_token:一種 JSON 網頁令牌(JWT)。 應用程式可以將此權杖的區段解碼,以索取已登入使用者的相關資訊。
  • refresh_token:OAuth 2.0 刷新代幣。 應用程式可以使用此代幣,在現有存取代幣到期後取得額外的存取權。
  • access_token:請求的存取令牌。 應用程式可以使用此權杖來對受保護的資源 (例如 Web API) 進行驗證。
  • client_info:客戶資訊物件
IdTokenClaims

類型描述 MSAL 已知的 Id Token 聲明。

InProgressPerformanceEvent
InitializeApplicationRequest

InitializeApplicationRequest:使用者傳遞的請求物件以初始化應用程式

  • correlationId - 每個請求唯一的 GUID 設定,用於遠端追蹤請求以進行遙測。
LoadTokenOptions
NavigationOptions

額外資訊傳遞給 navigateInternal 與 navigateExternal 函式

NetworkRequestOptions

網路請求 API 允許的選項。

NetworkResponse
PerformanceCallbackFunction
PerformanceEvent

函式庫會進行效能測量,包括關於請求與應用程式的元資料。

PopupEvent
PopupPosition
PopupRequest

PopupRequest:使用者傳遞的請求物件,用來從伺服器(授權碼授權流程的第一段)取得代碼,並以彈出視窗呈現。

  • 範圍(scopes)-應用程式請求存取權限的範圍陣列。
  • authority - 應用程式取得代幣的權威的網址。
  • correlationId - 每個請求唯一的 GUID 設定,用於遠端追蹤請求以進行遙測。
  • redirectUri - 可由您的應用程式接收認證回應的重定向 URI。 它必須與 Azure 入口網站中登記的其中一個重定向 URI 完全吻合。
  • extraScopesToConsent - 當使用者事先需要同意時,為不同資源設定範圍。
  • state - 請求中包含的值,且同時在標記回應中回傳。 通常使用隨機產生的唯一值來防止跨站請求偽造攻擊。 該狀態也用於編碼使用者在驗證請求發生前的狀態資訊。
  • 提示 - 表示所需的使用者互動類型。 登入:會強制使用者在該請求中輸入憑證,否定單點登入 none:確保使用者不會看到任何互動式提示。 若無法透過單點登入完成請求,端點會回傳interaction_required錯誤同意:使用者登入後會觸發 OAuth 同意對話框,要求使用者授權應用程式嗎?select_account:會中斷單點登入=ON,提供帳號選擇體驗,列出會話中所有帳號或任何被記憶的帳號,或提供選擇使用不同帳號的選項,建立: 會引導使用者進入帳號建立體驗,而非登入體驗 no_session:在驗證使用者時不會讀取現有的會話令牌。 使用者成功認證後,EVO 不會為該使用者建立新的會話。 僅限內部使用。
  • loginHint - 如果你事先知道使用者名稱或電子郵件地址,可以用來預先填入登入頁面的使用者名稱/電子郵件欄位。 應用程式通常在重新認證時會使用此參數,因為他們已經從先前登入時透過login_hint或preferred_username聲明擷取了使用者名稱。
  • sid - 會話識別碼,會話的唯一識別碼。 作為身份證代幣的可選申請。
  • domainHint - 提供使用者應使用以登入的租戶或網域提示。 網域提示的價值是租戶註冊的網域。
  • extraQueryParameters - 將自訂查詢參數的字串映射到 /authorize 呼叫中
  • tokenBodyParameters - 自訂令牌請求本體參數的字串對字串映射,並加入 /token 呼叫。 僅在續約存取權杖時使用。
  • tokenQueryParameters - 將自訂查詢參數的字串對字串映射到 /token 呼叫中
  • 聲明 - 當 Azure AD 租戶管理員啟用條件存取政策,且政策未被滿足時,例外將包含需要同意的聲明。
  • nonce - 請求中包含的值,並以 id 標記回傳。 通常會使用隨機產生的唯一數值來減少重播攻擊。
  • popupWindowAttributes - 可選的彈出視窗屬性。 popupSize 可以設定高度和寬度,以及 popupPosition 的上下與左邊。
  • popupWindowParent - 可選的視窗物件,當開啟彈出視窗時用作父視窗。 如果沒有給出,則使用全域 window
PopupSize
PopupWindowAttributes

彈出視窗尺寸與位置設定

RedirectRequest

RedirectRequest:使用者傳遞的請求物件,用於從伺服器(授權碼授權流程的第一段)取得代碼,並進行整頁重定向。

  • 範圍(scopes)-應用程式請求存取權限的範圍陣列。
  • authority - 應用程式取得代幣的權威的網址。
  • correlationId - 每個請求唯一的 GUID 設定,用於遠端追蹤請求以進行遙測。
  • redirectUri - 可由您的應用程式接收認證回應的重定向 URI。 它必須與 Azure 入口網站中登記的其中一個重定向 URI 完全吻合。
  • extraScopesToConsent - 當使用者事先需要同意時,為不同資源設定範圍。
  • state - 請求中包含的值,且同時在標記回應中回傳。 通常使用隨機產生的唯一值來防止跨站請求偽造攻擊。 該狀態也用於編碼使用者在驗證請求發生前的狀態資訊。
  • 提示 - 表示所需的使用者互動類型。 登入:會強制使用者在該請求中輸入憑證,否定單點登入 none:確保使用者不會看到任何互動式提示。 若無法透過單點登入完成請求,端點會回傳interaction_required錯誤同意:使用者登入後會觸發 OAuth 同意對話框,要求使用者授權應用程式嗎?select_account:會中斷單點登入=ON,提供帳號選擇體驗,列出會話中所有帳號或任何被記憶的帳號,或提供選擇使用不同帳號的選項,建立: 會引導使用者進入帳號建立體驗,而非登入體驗 no_session:在驗證使用者時不會讀取現有的會話令牌。 使用者成功認證後,EVO 不會為該使用者建立新的會話。 僅限內部使用。
  • loginHint - 如果你事先知道使用者名稱或電子郵件地址,可以用來預先填入登入頁面的使用者名稱/電子郵件欄位。 應用程式通常在重新認證時會使用此參數,因為他們已經從先前登入時透過login_hint或preferred_username聲明擷取了使用者名稱。
  • sid - 會話識別碼,會話的唯一識別碼。 作為身份證代幣的可選申請。
  • domainHint - 提供使用者應使用以登入的租戶或網域提示。 網域提示的價值是租戶註冊的網域。
  • extraQueryParameters - 將自訂查詢參數的字串映射到 /authorize 呼叫中
  • tokenBodyParameters - 自訂令牌請求本體參數的字串對字串映射,並加入 /token 呼叫。 僅在續約存取權杖時使用。
  • tokenQueryParameters - 將自訂查詢參數的字串對字串映射到 /token 呼叫中
  • 聲明 - 當 Azure AD 租戶管理員啟用條件存取政策,且政策未被滿足時,例外將包含需要同意的聲明。
  • nonce - 請求中包含的值,並以 id 標記回傳。 通常會使用隨機產生的唯一數值來減少重播攻擊。
  • redirectStartPage - 登入Redirect或acquireTokenRedirect後應返回的頁面。 只有當這與 redirectUri 不同,且預設會回到發起請求的頁面時,才應該使用。 當 navigateToLoginRequestUrl 設定選項設為 false 時,這個參數會被忽略。
  • onRedirectNavigate - 回調,將傳遞給 MSAL 所導航的網址。 回調時回傳 false 會停止導航。
SignedHttpRequestOptions
SilentRequest

SilentRequest:使用者傳遞的請求物件,用於從快取中取回標記、用刷新標記更新過期的標記,或在隱藏的 iframe 中取得代碼(授權碼授予流程的第一段)。

  • 範圍(scopes)-應用程式請求存取權限的範圍陣列。
  • authority - 應用程式取得代幣的權威的網址。
  • correlationId - 每個請求唯一的 GUID 設定,用於遠端追蹤請求以進行遙測。
  • 帳戶 - 帳戶實體用來查詢憑證。
  • forceRefresh - 如果為真,強制靜默請求進行網路呼叫。
  • extraQueryParameters - 自訂查詢參數的字串對字串映射,新增於 /authorize 呼叫中。 只在續約刷新代幣時使用。
  • tokenBodyParameters - 自訂令牌請求本體參數的字串對字串映射,並加入 /token 呼叫。 僅在續約存取權杖時使用。
  • tokenQueryParameters - 將自訂查詢參數的字串對字串映射,加入 /token 呼叫。 僅在續約存取權杖時使用。
  • redirectUri - 可由您的應用程式接收認證回應的重定向 URI。 它必須與 Azure 入口網站中登記的其中一個重定向 URI 完全吻合。 僅用於刷新令牌過期的情況。
  • cacheLookupPolicy - 列舉多種靜默令牌可檢索方式。
  • 提示 - 表示所需的使用者互動類型。 無:確保使用者不會看到任何互動式提示。 若無法透過單點登入完成請求,端點會回傳interaction_required錯誤no_session:在驗證使用者時不會讀取現有的會話令牌。 使用者成功認證後,EVO 不會為該使用者建立新的會話。 僅限內部使用。
SsoSilentRequest

使用者傳遞給 ssoSilent 以從伺服器取得代碼的請求物件(授權碼授權流程的第一段)

  • scopes - 應用程式請求存取權限的範圍陣列(ssoSilent 呼叫可選)
  • claims - 一個被要求的嚴格索賠請求,會被加入所有 /authorize 和 /token 呼叫中
  • authority - 應用程式取得代幣的權威的網址。
  • correlationId - 每個請求唯一的 GUID 設定,用於遠端追蹤請求以進行遙測。
  • redirectUri - 可由您的應用程式接收認證回應的重定向 URI。 它必須與 Azure 入口網站中登記的其中一個重定向 URI 完全吻合。
  • extraScopesToConsent - 當使用者事先需要同意時,為不同資源設定範圍。
  • state - 請求中包含的值,且同時在標記回應中回傳。 通常使用隨機產生的唯一值來防止跨站請求偽造攻擊。 該狀態也用於編碼使用者在驗證請求發生前的狀態資訊。
  • 提示 - 表示所需的使用者互動類型。 登入:會強制使用者在該請求中輸入憑證,否定單點登入 none:確保使用者不會看到任何互動式提示。 若無法透過單點登入完成請求,端點會回傳interaction_required錯誤同意:使用者登入後會觸發 OAuth 同意對話框,要求使用者授權應用程式權限 select_account:會中斷單點登入=開啟,提供帳號選擇體驗,列出會話中所有帳號或記憶帳號,或提供選擇使用不同帳號的選項,建立: 會引導使用者進入帳號建立體驗,而非登入體驗 no_session:在驗證使用者時不會讀取現有的會話令牌。 使用者成功認證後,EVO 不會為該使用者建立新的會話。 僅限內部使用。
  • loginHint - 如果你事先知道使用者名稱或電子郵件地址,可以用來預先填入登入頁面的使用者名稱/電子郵件欄位。 應用程式通常在重新認證時會使用此參數,因為他們已經從先前登入時透過login_hint或preferred_username聲明擷取了使用者名稱。
  • sid - 會話識別碼,會話的唯一識別碼。 作為身份證代幣的可選申請。
  • domainHint - 提供使用者應使用以登入的租戶或網域提示。 網域提示的價值是租戶註冊的網域。
  • extraQueryParameters - 將自訂查詢參數的字串映射到 /authorize 呼叫中
  • tokenBodyParameters - 自訂令牌請求本體參數的字串對字串映射,並加入 /token 呼叫。 僅在續約存取權杖時使用。
  • tokenQueryParameters - 將自訂查詢參數的字串對字串映射到 /token 呼叫中
  • nonce - 請求中包含的值,並以 id 標記回傳。 通常會使用隨機產生的唯一數值來減少重播攻擊。
TenantProfile

同一使用者的帳號細節在不同租戶間有所不同

AccessTokenRetrievalInputs
AccountRetrievalInputs
AuthMethodRegistrationChallengeMethodResultState

AuthMethodRegistrationChallengeMethodResult中可能狀態的類型定義。

AuthMethodRegistrationSubmitChallengeResultState

在 AuthMethodRegistrationSubmitChallengeResult 中,為可能狀態的類型定義。

CustomAuthConfiguration
GetAccessTokenResultState

GetAccessTokenResult 的可能狀態。 這包括:

  • GetAccessTokenCompletedState:存取權杖已成功取得。
  • GetAccessTokenFailedState:存取權杖取回失敗。
GetAccountResultState

GetAccountResult 可能的狀態。 這包括:

  • GetAccountCompletedState:該帳號已成功被取回。
  • GetAccountFailedState:帳號檢索失敗。
MfaRequestChallengeResultState

MfaRequestChallengeResult 可能的狀態。 這包括:

  • MfaVerificationRequiredState:使用者需要驗證他們的挑戰。
  • MfaFailedState:MFA申請失敗。
MfaSubmitChallengeResultState
ResetPasswordInputs
ResetPasswordResendCodeResultState

ResetPasswordResendCodeResult 的可能狀態。 這包括:

  • ResetPasswordCodeRequiredState:重設密碼的過程需要輸入一個代碼。
  • ResetPasswordFailedState:重設密碼程序失敗。
ResetPasswordStartResultState

ResetPasswordStartResult 的可能狀態。 這包括:

  • ResetPasswordCodeRequiredState:重設密碼的過程需要輸入一個代碼。
  • ResetPasswordFailedState:重設密碼程序失敗。
ResetPasswordSubmitCodeResultState

ResetPasswordSubmitCodeResult 的可能狀態。 這包括:

  • ResetPasswordPasswordRequiredState:重設密碼的過程需要密碼。
  • ResetPasswordFailedState:重設密碼程序失敗。
ResetPasswordSubmitPasswordResultState

ResetPasswordSubmitPasswordResult 的可能狀態。 這包括:

  • ResetPasswordCompletedState:重設密碼的流程已成功完成。
  • ResetPasswordFailedState:重設密碼程序失敗。
SignInInputs
SignInResendCodeResultState

SignInResendCodeResult 的可能狀態。 這包括:

  • SignInCodeRequiredState:登入過程需要一個代碼。
  • SignInFailedState:登入流程失敗。
SignInResultState

SignInResult 的可能狀態。 這包括:

  • SignInCodeRequiredState:登入過程需要一個代碼。
  • SignInPasswordRequiredState:登入過程需要密碼。
  • SignInFailedState:登入流程失敗。
  • 登入完成狀態:登入流程已完成。
  • AuthMethodRegistrationRequiredState:登入過程需要註冊認證方法。
  • MfaAwaitingState:登入流程需要多重身份驗證(MFA)。
SignInSubmitCodeResultState

SignInSubmitCodeResult 的可能狀態。 這包括:

  • 登入完成狀態:登入流程已成功完成。
  • SignInFailedState:登入流程失敗。
  • AuthMethodRegistrationRequiredState:使用者需要註冊一種認證方法。
  • MfaAwaitingState:使用者處於多重身份驗證(MFA)等待狀態。
SignInSubmitPasswordResultState

SignInSubmitPasswordResult 可能的狀態。 這包括:

  • 登入完成狀態:登入流程已成功完成。
  • SignInFailedState:登入流程失敗。
  • AuthMethodRegistrationRequiredState:登入過程需要註冊認證方法。
  • MfaAwaitingState:登入流程需要多重身份驗證(MFA)。
SignInWithContinuationTokenInputs
SignOutResultState

SignOutResult 的可能狀態。 這包括:

  • SignOutCompletedState:登出操作成功。
  • SignOutFailedState:登出操作失敗。
SignUpInputs
SignUpResendCodeResultState

SignUpResendCodeResult 的可能狀態。 這包括:

  • SignUpCodeRequiredState:註冊流程需要輸入代碼。
  • SignUpFailedState:註冊流程失敗。
SignUpResultState

SignUpResult 的可能狀態。 這包括:

  • SignUpCodeRequiredState:註冊流程需要輸入代碼。
  • SignUpPasswordRequiredState:註冊流程需要密碼。
  • SignUpAttributesRequiredState:註冊流程需要額外屬性。
  • SignUpFailedState:註冊流程失敗。
SignUpSubmitAttributesResultState

SignUpSubmitAttributesResult 的可能狀態。 這包括:

  • SignUpCompletedState:註冊流程已成功完成。
  • SignUpFailedState:註冊流程失敗。
SignUpSubmitCodeResultState

SignUpSubmitCodeResult 的可能狀態。 這包括:

  • SignUpPasswordRequiredState:註冊流程需要密碼。
  • SignUpAttributesRequiredState:註冊流程需要額外屬性。
  • SignUpCompletedState:註冊流程已成功完成。
  • SignUpFailedState:註冊流程失敗。
SignUpSubmitPasswordResultState

SignUpSubmitPasswordResult 的可能狀態。 這包括:

  • SignUpAttributesRequiredState:註冊流程需要額外屬性。
  • SignUpCompletedState:註冊流程已成功完成。
  • SignUpFailedState:註冊流程失敗。
UserAccountAttributes

列舉

InteractionType
PerformanceEvents

透過 的操作列舉,其效能由 PerformanceClient 衡量。

LogLevel

日誌訊息層級。

函式

createNestablePublicClientApplication(Configuration)

產生 NestedAppAuthController 並傳給 PublicClientApplication,若無法使用 NestedAppAuthController 則退回到 StandardController

createStandardPublicClientApplication(Configuration)

使用 StandardController 建立 PublicClientApplication

isPlatformBrokerAvailable(LoggerOptions, IPerformanceClient, string, boolean)

檢查平台經紀人在目前環境中是否可用。

變數

ApiId

用於遙測目的的 API 代碼。 0-99 靜默流程 800-899 認證碼流程 900-999 雜項

AuthenticationScheme

認證請求類型

AzureCloudInstance
BrowserCacheLocation
CacheLookupPolicy
EventType
InteractionStatus

目前正在進行的互動類型。 用於包裝函式庫中的事件中,當某些互動進行中或所有互動完成時,呼叫函式。

JsonWebTokenTypes
ProtocolMode

MSAL 支援的協定模式。

ServerResponseType

伺服器回應類型的允許值

WrapperSKU
AuthErrorMessage

AuthErrorMessage 類別包含錯誤碼與訊息所使用的字串常數。

BrowserAuthErrorMessage

BrowserAuthErrorMessage 類別包含錯誤碼與訊息所用的字串常數。

BrowserConfigurationAuthErrorMessage

BrowserAuthErrorMessage 類別包含錯誤碼與訊息所用的字串常數。

ClientAuthErrorMessage

錯誤碼與訊息所用的字串常數。

ClientConfigurationErrorMessage

ClientConfigurationErrorMessage 類別,包含錯誤碼與訊息所使用的字串常數。

DEFAULT_IFRAME_TIMEOUT_MS
InteractionRequiredAuthErrorMessage

互動需要依 SDK 定義的錯誤進行

OIDC_DEFAULT_SCOPES
PromptValue

我們曾考慮在請求中將「列舉」取代字串,但看起來允許的提示值清單在過去幾年一直在變動。 有些內部合作夥伴的提示值也未被記錄,因此選擇了通用的「字串」類型而非「列舉」

stubbedPublicClientApplication
version

函式詳細資料

createNestablePublicClientApplication(Configuration)

產生 NestedAppAuthController 並傳給 PublicClientApplication,若無法使用 NestedAppAuthController 則退回到 StandardController

function createNestablePublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>

參數

configuration
Configuration

傳回

IPublicClientApplication

createStandardPublicClientApplication(Configuration)

使用 StandardController 建立 PublicClientApplication

function createStandardPublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>

參數

configuration
Configuration

傳回

IPublicClientApplication

isPlatformBrokerAvailable(LoggerOptions, IPerformanceClient, string, boolean)

檢查平台經紀人在目前環境中是否可用。

function isPlatformBrokerAvailable(loggerOptions?: LoggerOptions, perfClient?: IPerformanceClient, correlationId?: string, domConfig?: boolean): Promise<boolean>

參數

loggerOptions
LoggerOptions
perfClient
IPerformanceClient
correlationId

string

domConfig

boolean

傳回

Promise<boolean>

變數詳細資料

ApiId

用於遙測目的的 API 代碼。 0-99 靜默流程 800-899 認證碼流程 900-999 雜項

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 }

類型

{ 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

認證請求類型

AuthenticationScheme: { BEARER: "Bearer", POP: "pop", SSH: "ssh-cert" }

類型

{ 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" }

類型

{ 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" }

類型

{ LocalStorage: "localStorage", MemoryStorage: "memoryStorage", SessionStorage: "sessionStorage" }

CacheLookupPolicy

CacheLookupPolicy: { AccessToken: 1, AccessTokenAndRefreshToken: 2, Default: 0, RefreshToken: 3, RefreshTokenAndNetwork: 4, Skip: 5 }

類型

{ 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" }

類型

{ 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

目前正在進行的互動類型。 用於包裝函式庫中的事件中,當某些互動進行中或所有互動完成時,呼叫函式。

InteractionStatus: { AcquireToken: "acquireToken", HandleRedirect: "handleRedirect", Login: "login", Logout: "logout", None: "none", SsoSilent: "ssoSilent", Startup: "startup" }

類型

{ AcquireToken: "acquireToken", HandleRedirect: "handleRedirect", Login: "login", Logout: "logout", None: "none", SsoSilent: "ssoSilent", Startup: "startup" }

JsonWebTokenTypes

JsonWebTokenTypes: { Jwk: "JWK", Jwt: "JWT", Pop: "pop" }

類型

{ Jwk: "JWK", Jwt: "JWT", Pop: "pop" }

ProtocolMode

MSAL 支援的協定模式。

ProtocolMode: { AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }

類型

{ AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }

ServerResponseType

警告

此 API 現已淘汰。

Use ResponseMode instead

伺服器回應類型的允許值

ServerResponseType: { FRAGMENT: "fragment", QUERY: "query" }

類型

{ FRAGMENT: "fragment", QUERY: "query" }

WrapperSKU

WrapperSKU: { Angular: "@azure/msal-angular", React: "@azure/msal-react" }

類型

{ Angular: "@azure/msal-angular", React: "@azure/msal-react" }

AuthErrorMessage

警告

此 API 現已淘汰。

Use AuthErrorCodes instead

AuthErrorMessage 類別包含錯誤碼與訊息所使用的字串常數。

AuthErrorMessage: { postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }

類型

{ postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }

BrowserAuthErrorMessage

警告

此 API 現已淘汰。

Use exported BrowserAuthErrorCodes instead. In your app you can do :

import { BrowserAuthErrorCodes } from "@azure/msal-browser";

BrowserAuthErrorMessage 類別包含錯誤碼與訊息所用的字串常數。

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 } }

類型

{ 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

警告

此 API 現已淘汰。

Use BrowserAuthErrorCodes instead

BrowserAuthErrorMessage 類別包含錯誤碼與訊息所用的字串常數。

BrowserConfigurationAuthErrorMessage: { inMemRedirectUnavailable: { code: string, desc: string }, storageNotSupportedError: { code: string, desc: string }, stubPcaInstanceCalled: { code: string, desc: string } }

類型

{ inMemRedirectUnavailable: { code: string, desc: string }, storageNotSupportedError: { code: string, desc: string }, stubPcaInstanceCalled: { code: string, desc: string } }

ClientAuthErrorMessage

警告

此 API 現已淘汰。

Use ClientAuthErrorCodes instead

錯誤碼與訊息所用的字串常數。

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 } }

類型

{ 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

警告

此 API 現已淘汰。

Use ClientConfigurationErrorCodes instead

ClientConfigurationErrorMessage 類別,包含錯誤碼與訊息所使用的字串常數。

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 } }

類型

{ 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

類型

10000

InteractionRequiredAuthErrorMessage

警告

此 API 現已淘汰。

Use InteractionRequiredAuthErrorCodes instead

互動需要依 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 } }

類型

{ 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[]

類型

string[]

PromptValue

我們曾考慮在請求中將「列舉」取代字串,但看起來允許的提示值清單在過去幾年一直在變動。 有些內部合作夥伴的提示值也未被記錄,因此選擇了通用的「字串」類型而非「列舉」

PromptValue: { CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }

類型

{ CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }

stubbedPublicClientApplication

stubbedPublicClientApplication: IPublicClientApplication

類型

version

version: "4.30.0"

類型

"4.30.0"