@azure/msal-browser package
類別
介面
類型別名
| AccountInfo |
帳號物件,簽名如下:
|
| AuthenticationResult | |
| AuthorizationCodeRequest | |
| AuthorizationUrlRequest |
此類型已被棄用,將於下一次重大版本更新中移除 |
| AzureCloudOptions |
AzureCloudInstance 專屬選項
|
| BrokerConnectionEvent |
BrokerConnectionEstablished 事件的有效載荷 |
| BrowserAuthOptions |
用這個來設定設定物件中的認證選項 |
| BrowserSystemOptions | |
| BrowserTelemetryOptions |
遙測選項 |
| CacheOptions |
請使用此方法設定以下快取設定選項: |
| ClearCacheRequest |
清除快取請求
|
| Configuration |
此物件允許你配置 MSAL 功能的重要元素,並被傳遞到 PublicClientApplication 的建構子中 |
| EndSessionPopupRequest |
EndSessionPopupRequest
|
| EndSessionRequest |
結束會話請求
|
| EventCallbackFunction | |
| EventError | |
| EventMessage | |
| EventPayload | |
| ExternalTokenResponse |
用於將外部標記載入快取的回應物件。
|
| IdTokenClaims |
類型描述 MSAL 已知的 Id Token 聲明。 |
| InProgressPerformanceEvent | |
| InitializeApplicationRequest |
InitializeApplicationRequest:使用者傳遞的請求物件以初始化應用程式
|
| LoadTokenOptions | |
| NavigationOptions |
額外資訊傳遞給 navigateInternal 與 navigateExternal 函式 |
| NetworkRequestOptions |
網路請求 API 允許的選項。 |
| NetworkResponse | |
| PerformanceCallbackFunction | |
| PerformanceEvent |
函式庫會進行效能測量,包括關於請求與應用程式的元資料。 |
| PopupEvent | |
| PopupPosition | |
| PopupRequest |
PopupRequest:使用者傳遞的請求物件,用來從伺服器(授權碼授權流程的第一段)取得代碼,並以彈出視窗呈現。
|
| PopupSize | |
| PopupWindowAttributes |
彈出視窗尺寸與位置設定 |
| RedirectRequest |
RedirectRequest:使用者傳遞的請求物件,用於從伺服器(授權碼授權流程的第一段)取得代碼,並進行整頁重定向。
|
| SignedHttpRequestOptions | |
| SilentRequest |
SilentRequest:使用者傳遞的請求物件,用於從快取中取回標記、用刷新標記更新過期的標記,或在隱藏的 iframe 中取得代碼(授權碼授予流程的第一段)。
|
| SsoSilentRequest |
使用者傳遞給 ssoSilent 以從伺服器取得代碼的請求物件(授權碼授權流程的第一段)
|
| TenantProfile |
同一使用者的帳號細節在不同租戶間有所不同 |
| AccessTokenRetrievalInputs | |
| AccountRetrievalInputs | |
| AuthMethodRegistrationChallengeMethodResultState |
AuthMethodRegistrationChallengeMethodResult中可能狀態的類型定義。 |
| AuthMethodRegistrationSubmitChallengeResultState |
在 AuthMethodRegistrationSubmitChallengeResult 中,為可能狀態的類型定義。 |
| CustomAuthConfiguration | |
| GetAccessTokenResultState |
GetAccessTokenResult 的可能狀態。 這包括:
|
| GetAccountResultState |
GetAccountResult 可能的狀態。 這包括:
|
| MfaRequestChallengeResultState |
MfaRequestChallengeResult 可能的狀態。 這包括:
|
| MfaSubmitChallengeResultState | |
| ResetPasswordInputs | |
| ResetPasswordResendCodeResultState |
ResetPasswordResendCodeResult 的可能狀態。 這包括:
|
| ResetPasswordStartResultState |
ResetPasswordStartResult 的可能狀態。 這包括:
|
| ResetPasswordSubmitCodeResultState |
ResetPasswordSubmitCodeResult 的可能狀態。 這包括:
|
| ResetPasswordSubmitPasswordResultState |
ResetPasswordSubmitPasswordResult 的可能狀態。 這包括:
|
| SignInInputs | |
| SignInResendCodeResultState |
SignInResendCodeResult 的可能狀態。 這包括:
|
| SignInResultState |
SignInResult 的可能狀態。 這包括:
|
| SignInSubmitCodeResultState |
SignInSubmitCodeResult 的可能狀態。 這包括:
|
| SignInSubmitPasswordResultState |
SignInSubmitPasswordResult 可能的狀態。 這包括:
|
| SignInWithContinuationTokenInputs | |
| SignOutResultState |
SignOutResult 的可能狀態。 這包括:
|
| SignUpInputs | |
| SignUpResendCodeResultState |
SignUpResendCodeResult 的可能狀態。 這包括:
|
| SignUpResultState |
SignUpResult 的可能狀態。 這包括:
|
| SignUpSubmitAttributesResultState |
SignUpSubmitAttributesResult 的可能狀態。 這包括:
|
| SignUpSubmitCodeResultState |
SignUpSubmitCodeResult 的可能狀態。 這包括:
|
| SignUpSubmitPasswordResultState |
SignUpSubmitPasswordResult 的可能狀態。 這包括:
|
| UserAccountAttributes | |
列舉
| InteractionType | |
| PerformanceEvents |
透過 的操作列舉,其效能由 PerformanceClient 衡量。 |
| LogLevel |
日誌訊息層級。 |
函式
| create |
產生 NestedAppAuthController 並傳給 PublicClientApplication,若無法使用 NestedAppAuthController 則退回到 StandardController |
| create |
使用 StandardController 建立 PublicClientApplication |
| is |
檢查平台經紀人在目前環境中是否可用。 |
變數
| Api |
用於遙測目的的 API 代碼。 0-99 靜默流程 800-899 認證碼流程 900-999 雜項 |
| Authentication |
認證請求類型 |
| Azure |
|
| Browser |
|
| Cache |
|
| Event |
|
| Interaction |
目前正在進行的互動類型。 用於包裝函式庫中的事件中,當某些互動進行中或所有互動完成時,呼叫函式。 |
| Json |
|
| Protocol |
MSAL 支援的協定模式。 |
| Server |
伺服器回應類型的允許值 |
| WrapperSKU | |
| Auth |
AuthErrorMessage 類別包含錯誤碼與訊息所使用的字串常數。 |
| Browser |
BrowserAuthErrorMessage 類別包含錯誤碼與訊息所用的字串常數。 |
| Browser |
BrowserAuthErrorMessage 類別包含錯誤碼與訊息所用的字串常數。 |
| Client |
錯誤碼與訊息所用的字串常數。 |
| Client |
ClientConfigurationErrorMessage 類別,包含錯誤碼與訊息所使用的字串常數。 |
| DEFAULT_IFRAME_TIMEOUT_MS | |
| Interaction |
互動需要依 SDK 定義的錯誤進行 |
| OIDC_DEFAULT_SCOPES | |
| Prompt |
我們曾考慮在請求中將「列舉」取代字串,但看起來允許的提示值清單在過去幾年一直在變動。 有些內部合作夥伴的提示值也未被記錄,因此選擇了通用的「字串」類型而非「列舉」 |
| stubbed |
|
| version |
函式詳細資料
createNestablePublicClientApplication(Configuration)
產生 NestedAppAuthController 並傳給 PublicClientApplication,若無法使用 NestedAppAuthController 則退回到 StandardController
function createNestablePublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>
參數
- configuration
- Configuration
傳回
Promise<IPublicClientApplication>
IPublicClientApplication
createStandardPublicClientApplication(Configuration)
使用 StandardController 建立 PublicClientApplication
function createStandardPublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>
參數
- configuration
- Configuration
傳回
Promise<IPublicClientApplication>
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
version
version: "4.30.0"
類型
"4.30.0"