@azure/msal-common package

類別

AuthError	MSAL.js 函式庫拋出的一般錯誤類別。
AuthenticationHeaderParser	這是一個輔助類別，解析支援的 HTTP 回應認證標頭，以提取並回傳可用於基本授權流程之外的標頭挑戰值。
CacheError	當快取發生錯誤時會拋出錯誤
ClientAuthError	當瀏覽器執行的客戶端程式碼出現錯誤時，會跳出錯誤。
ClientConfigurationError	當 MSAL.js 函式庫設定錯誤時會拋出錯誤。
InteractionRequiredAuthError	當需要使用者互動時會拋出錯誤。
Logger	類別協助將訊息記錄到特定位置。
NetworkError	代表網路相關錯誤
PerformanceClient
PlatformBrokerError	MSAL 執行時錯誤類別，保留詳細的經紀人資訊
ProtocolUtils	類別提供 OAuth 2.0 協定特定值的輔助工具
ScopeSet	ScopeSet 類別會建立一組範圍。 作用域是不區分大小寫且唯一的值，因此 JS 中的 Set 物件是這個類別最合理的實作方式。 所有作用域都會在交集與聯集函數中修剪並轉換為小寫字串，以確保字串的唯一性。
ServerError	當伺服器程式碼出現錯誤時會拋出錯誤，例如無法使用。
StubPerformanceClient
UrlString	URL 物件類別，可以對 URL 字串執行各種轉換。
TokenCacheContext	此類別實例有助於追蹤記憶體變更，方便決策從持久快取讀取與寫入

介面

ICrypto	函式庫使用的加密函式介面
ILoggerCallback
INetworkModule	用戶端網路介面用來發送後端請求。
IPerformanceClient
IPerformanceMeasurement
IUri	介面描述 URI 元件。
PreQueueEvent
IAppTokenProvider
ICachePlugin
IGuidGenerator
INativeBrokerPlugin
ISerializableTokenCache

類型別名

AccessTokenEntity	存取權杖快取類型
AccountFilter	帳號：<home_account_id-environment-realm<><>*>
AccountInfo	帳號物件，簽名如下： homeAccountId - 此帳戶物件的 Home account 識別碼 environment-發行由發行者域名代表的代幣的實體（例如 login.microsoftonline.com） tenantId - 該帳號所屬的完整租戶或組織識別碼 用戶名 - preferred_username代表此帳號的id_token聲稱 localAccountId - 本機、租戶專用的帳號識別碼，通常用於舊有案件 姓名 - 帳戶的全名，包括名字和姓氏 idToken - 原始 ID 令牌 idTokenClaims - 物件包含來自 ID 憑證的聲明 nativeAccountId-使用者的原生帳號ID tenantProfiles - 每個帳號在瀏覽器中驗證過的租戶資料物件映射 dataBoundary - 從 clientInfo 擷取的資料邊界
ActiveAccountFilters
AppMetadataEntity	應用程式中繼資料快取類型
ApplicationTelemetry	應請求傳送的遙測資訊 appName：應用程式的唯一字串名稱 appVersion：使用 MSAL 的應用程式版本
AuthenticationResult	結果是從權威機構的代幣端點回傳的。 uniqueId—— oid 或 sub 從ID標記取得的聲明 tenantId - tid 從 ID 令牌提出的聲明 範圍 - 針對相應令牌經過驗證的範圍 account-目前登入使用者的帳號物件表示 idToken - 作為回應一部分收到的 ID 令牌 idTokenClaims - MSAL 相關的 ID 令牌聲明 accessToken - 作為回應一部分收到的存取令牌或 SSH 憑證 fromCache - 布林值表示 token 是否來自 cache expiresOn - Javascript Date 物件，代表存取權杖的相對到期時間 extExpiresOn - Javascript Date 物件，代表伺服器中斷時存取權杖的延伸相對到期 refreshOn - Javascript Date 物件，代表存取權杖必須刷新前的相對時間 state - 使用者在請求中傳遞的值 familyID - 家庭識別碼識別碼，通常僅用於刷新標記 requestId - 回應中回傳的請求 ID
AuthorityOptions
AuthorizationCodePayload	回應在處理程式碼回應查詢字串或片段後回傳。
AuthorizeResponse	/authorize 端點可能回傳的回應屬性
AzureCloudOptions	AzureCloudInstance 專屬選項 azureCloudInstance - string enum 提供主權及公共雲權威的簡短符號 租戶 - 提供租戶資訊的條款
AzureRegion
AzureRegionConfiguration
BaseAuthRequest	BaseAuthRequest authority - 權限機構的網址，即 MSAL 取得權杖的安全性憑證服務（STS）。 預設為 https://login.microsoftonline.com/common。 如果所有請求都使用相同的權威，權威應該設在客戶端應用程式物件上，而非請求，以避免多次解析權威端點。 correlationId - 每個請求唯一的 GUID 設定，用於遠端追蹤請求以進行遙測。 範圍（scopes）-應用程式請求存取權限的範圍陣列。 AuthenticationScheme - 所取得的憑證類型。 預設為「承載者」。 也可以是「pop」或「SSH」類型。 claims - 一個被要求的嚴格索賠請求，會被加入所有 /authorize 和 /token 呼叫中 shrClaims - 一個被加入已簽署 HTTP 請求的 stringified claims 物件 shrNonce - 一個由伺服器產生的時間戳，已加密並以 base64URL 編碼，將被加入 Signed HTTP 請求中。 shrOptions - 包含簽署 HTTP 請求選項的物件 resourceRequestMethod - 用於從資源請求資料的 HTTP 請求類型（例如「GET」、「POST」等）。 用於持有權證明流程。 resourceRequestUri - 該標記將用於的 URI。 用於持有權證明流程。 sshJwk - 一個串聯的 JSON Web 金鑰，代表一個公鑰，可由 SSH 憑證簽署。 sshKid - 唯一識別上述 SSH 公鑰的金鑰 ID。 azureCloudOptions - 方便用戶提供公有/主權雲 ID 的函式列舉 requestedClaimsHash - SHA 256 請求權利要求字串的雜湊字串，作為存取權杖快取金鑰的一部分，以便被請求權稱過濾 tokenQueryParameters - 將自訂查詢參數的字串對字串映射到 /token 呼叫中 tokenBodyParameters - 將自訂參數加入 /token 呼叫主體的字串對字串映射 storeInCache - 包含布林值的物件，指示是否要將標記存放在快取中（預設為真） scenarioId - 用於追蹤自訂使用者提示的情境ID popKid - 用於識別 PoP 令牌請求公鑰的金鑰 ID embeddedClientID - 嵌入客戶端 ID。指定時，代理客戶 ID（brk_client_id）與重定向 uri（brk_redirect_uri）參數會以設定檔中的值設定，若有則覆蓋相應的額外參數。 httpMethod - 用於 /authorize 請求的 HTTP 方法。 預設為 GET，但如果請求需要 body 參數，也可以設為 POST authorizePostBodyParameters - 當 httpMethod 設為 POST 時，自訂參數的字串對字串映射到 /authorize 呼叫的主體中 skipBrokerClaims - 當為真且使用經紀流程（例如存在經紀參數或嵌入客戶 ID）時，設定中的 clientCapabilities 將被排除在理賠之外;非經紀資金流則被忽略。
CacheOptions	利用此工具在 ClientConfiguration 物件中設定憑證快取偏好 claimsBasedCachingEnabled - 根據權利要求的雜湊值設定是否應該快取權杖。 預設值為 false。
CcsCredential
ClientInfo	用戶端資訊物件，包含以下：uid：使用者 ID、utid：租戶ID xms_tdbr：可選，僅限非美國租戶使用
CommonAuthorizationCodeRequest	使用者傳遞的請求物件，用於從伺服器取得一個憑證，交換有效的授權碼（OAuth2.0 授權碼流程的第二段） 範圍（scopes）-應用程式請求存取權限的範圍陣列。 claims - 一個被要求的嚴格索賠請求，會被加入所有 /authorize 和 /token 呼叫中 權限：- 權限機構的網址，即 MSAL 取得憑證的安全憑證服務（STS）。 如果 authority 是設定在用戶端應用程式物件上，這會覆蓋該值。 覆寫該數值每次都會進行權威驗證。 如果所有請求都使用相同的權限，請設定在應用程式物件上，而非請求本身。 correlationId - 每個請求唯一的 GUID 設定，用於遠端追蹤請求以進行遙測。 redirectUri - 你應用程式的重定向 URI，使用者輸入憑證並同意後，權威將重新導向到該 URI。 它必須完全符合你在入口網站註冊的重定向 URI 之一 程式碼 - 使用者在流程第一階段取得的authorization_code。 codeVerifier - 與取得authorization_code相同的code_verifier。 若在授權碼授權申請中使用 PKCE，則必須如此。欲了解更多資訊，請參閱PKCE RFC： https://tools.ietf.org/html/rfc7636 resourceRequestMethod - 用於從資源請求資料的 HTTP 請求類型（例如「GET」、「POST」等）。 用於持有權證明流程。 resourceRequestUri - 該標記將用於的 URI。 用於持有權證明流程。 enableSpaAuthCode - 啟用 spa 授權碼的取得（僅限機密用戶端） tokenQueryParameters - 將自訂查詢參數的字串對字串映射到 /token 呼叫中
CommonAuthorizationUrlRequest	使用者傳遞的請求物件用來從伺服器取回代碼（授權碼授權流程的第一段） 範圍（scopes）-應用程式請求存取權限的範圍陣列。 claims - 一個被要求的嚴格索賠請求，會被加入所有 /authorize 和 /token 呼叫中 authority - 應用程式取得代幣的權威的網址。 correlationId - 每個請求唯一的 GUID 設定，用於遠端追蹤請求以進行遙測。 redirectUri - 可由您的應用程式接收認證回應的重定向 URI。 它必須與 Azure 入口網站中登記的其中一個重定向 URI 完全吻合。 extraScopesToConsent - 當使用者事先需要同意時，為不同資源設定範圍。 responseMode - 指定傳送驗證結果到應用程式的方法。 可以是查詢、form_post或片段。 如果沒有傳遞任何值，則預設為查詢。 codeChallenge - 用於透過 Code Exchange 的 Proof of Key （PKCE） 確保授權碼授予。 欲了解更多資訊，請參閱PKCE區域資源基金：https://tools.ietf.org/html/rfc7636 codeChallengeMethod - 用於編碼程式碼驗證器以編碼 code challenge 參數的方法。 可以是「普通」或「S256」。 若排除，則假設程式碼挑戰為明文。 欲了解更多資訊，請參閱PKCE區域資源基金： https://tools.ietf.org/html/rfc7636 state - 請求中包含的值，且同時在標記回應中回傳。 通常使用隨機產生的唯一值來防止跨站請求偽造攻擊。 該狀態也用於編碼使用者在驗證請求發生前的狀態資訊。 提示 - 表示所需的使用者互動類型。 登入：會強制使用者在該請求中輸入憑證，否定單點登入 none：確保使用者不會看到任何互動式提示。 若無法透過單點登入完成請求，端點會回傳interaction_required錯誤同意：使用者登入後會觸發 OAuth 同意對話框，要求使用者授權應用程式嗎？select_account：會中斷單點登入=ON，提供帳號選擇體驗，列出會話中所有帳號或任何被記憶的帳號，或提供選擇使用不同帳號的選項，建立： 會引導使用者進入帳號建立體驗，而非登入體驗 no_session：在驗證使用者時不會讀取現有的會話令牌。 使用者成功認證後，EVO 不會為該使用者建立新的會話。 僅限內部使用。 帳戶 - 從 getAccount API 取得的帳戶資訊。 若未同時提供 loginHint 和 sid 參數，則會在特定情境下用於產生login_hint。 loginHint - 如果你事先知道使用者名稱或電子郵件地址，可以用來預先填入登入頁面的使用者名稱/電子郵件欄位。 應用程式通常在重新認證時會使用此參數，因為他們已經從先前登入時用preferred_username聲明擷取了使用者名稱。 sid - 會話識別碼，會話的唯一識別碼。 作為身份證代幣的可選申請。 domainHint - 提供使用者應使用以登入的租戶或網域提示。 網域提示的價值是租戶註冊的網域。 extraQueryParameters - 將自訂查詢參數的字串映射到 /authorize 呼叫中 tokenQueryParameters - 將自訂查詢參數的字串對字串映射到 /token 呼叫中 nonce - 請求中包含的值，並以 id 標記回傳。 通常會使用隨機產生的唯一數值來減少重播攻擊。 resourceRequestMethod - 用於從資源請求資料的 HTTP 請求類型（例如「GET」、「POST」等）。 用於持有權證明流程。 resourceRequestUri - 該標記將用於的 URI。 用於持有權證明流程。
CommonEndSessionRequest	CommonEndSessionRequest 帳號 - 將被登出的帳號物件。 所有綁定此帳戶的代幣都會被清算。 postLogoutRedirectUri - URI 可導航至登出後頁面。 correlationId - 每個請求唯一的 GUID 設定，用於遠端追蹤請求以進行遙測。 idTokenHint - B2C 用於驗證登出的 ID 憑證（若政策要求） 狀態 - 請求登出端點時包含的值，登出後重定向時會以查詢字串回傳 logoutHint - 一個字串，指定要登出的帳號，以便在登出時跳過伺服器帳號選擇器 extraQueryParameters - 將自訂查詢參數的字串映射到 /authorize 呼叫中
CommonRefreshTokenRequest	CommonRefreshTokenRequest 範圍（scopes）-應用程式請求存取權限的範圍陣列。 claims - 一個被要求的嚴格索賠請求，會被加入所有 /authorize 和 /token 呼叫中 authority - 權限機構的網址，即 MSAL 取得權杖的安全性憑證服務（STS）。 correlationId - 每個請求唯一的 GUID 設定，用於遠端追蹤請求以進行遙測。 refreshToken - 從先前向身份提供者請求回傳的刷新權杖。 resourceRequestMethod - 用於從資源請求資料的 HTTP 請求類型（例如「GET」、「POST」等）。 用於持有權證明流程。 resourceRequestUri - 該標記將用於的 URI。 用於持有權證明流程。 forceCache - 強制 MSAL 在快取中沒有帳號時快取刷新權杖流程回應。 用於遷移情境。 tokenQueryParameters - 將自訂查詢參數的字串對字串映射到 /token 呼叫中
CommonSilentFlowRequest	使用者傳遞的 SilentFlow 參數用來靜默取得憑證 範圍（scopes）-應用程式請求存取權限的範圍陣列。 claims - 一個嚴格的聲明請求，會被加入所有 /authorize 和 /token 呼叫中。 當靜默請求中包含快取查詢時，會跳過快取查找並刷新令牌。 authority - 應用程式取得代幣的權威的網址。 correlationId - 每個請求唯一的 GUID 設定，用於遠端追蹤請求以進行遙測。 帳戶 - 帳戶實體用來查詢憑證。 forceRefresh - 如果為真，強制靜默請求進行網路呼叫。 resourceRequestMethod - 用於從資源請求資料的 HTTP 請求類型（例如「GET」、「POST」等）。 用於持有權證明流程。 resourceRequestUri - 該標記將用於的 URI。 用於持有權證明流程。 tokenQueryParameters - 將自訂查詢參數的字串對字串映射到 /token 呼叫中
CredentialEntity	憑證快取類型
CredentialFilter	憑證：<home_account_id*>-<environment-credential_type-client_id-realm<<>><>*>-<target*>-<scheme*>
ExternalTokenResponse	用於將外部標記載入快取的回應物件。 token_type：表示代幣類型的價值。 Azure AD 唯一支援的類型是承載者。 範圍：access_token有效範圍內的範圍。 expires_in：存取權杖有效時間（以秒計）。 id_token：一種 JSON 網頁令牌（JWT）。 應用程式可以將此權杖的區段解碼，以索取已登入使用者的相關資訊。 refresh_token：OAuth 2.0 刷新代幣。 應用程式可以使用此代幣，在現有存取代幣到期後取得額外的存取權。 access_token：請求的存取令牌。 應用程式可以使用此權杖來對受保護的資源 (例如 Web API) 進行驗證。 client_info：客戶資訊物件
IdTokenEntity	ID 標記快取類型
InProgressPerformanceEvent
LibraryStateObject	類型定義了被綁定、編碼並傳送到狀態值中的物件。 包含以下內容： ID - 此請求的唯一識別碼 TS - 請求提出的時間戳記。 用來確保代幣到期不會被錯誤計算。 platformState - 平台傳送的字串值。
LoggerOptions	利用此功能設定 MSAL 執行的日誌功能，透過設定設定物件中的日誌選項 loggerCallback - 對 logger 的回呼 piiLoggingEnabled - 設定是否啟用 pii 記錄 logLevel - 設定記錄發生的層級 correlationId - 設定由記錄器列印的 correlationId。
NetworkRequestOptions	網路請求 API 允許的選項。
NetworkResponse
OIDCOptions	OIDC 協定模式的選項。
PerformanceCallbackFunction
PerformanceEvent	函式庫會進行效能測量，包括關於請求與應用程式的元資料。
PkceCodes	PkceCodes 類型描述包含 PKCE 碼挑戰與驗證器對的物件結構
QueueMeasurement	佇列測量類型
RefreshTokenEntity	刷新令牌快取類型
RequestStateObject	型別定義授權請求中送給服務的串聯化且編碼的物件。
RequestThumbprint	代表唯一請求的拇指紋。
ServerAuthorizationTokenResponse	伺服器授權碼請求的反序列化回應物件。 token_type：表示代幣類型的價值。 可以是承載者或爆破者。 範圍：access_token有效範圍內的範圍。 expires_in：存取權杖有效時間（以秒計）。 refresh_in：代幣應續期的時間，無論到期時間是否。 ext_expires_in：如果伺服器沒有回應，存取權杖有效時間（以秒計）。 access_token：請求的存取令牌。 應用程式可以使用此權杖來對受保護的資源 (例如 Web API) 進行驗證。 refresh_token：OAuth 2.0 刷新代幣。 應用程式可以使用此代幣，在現有存取代幣到期後取得額外的存取權。 id_token：一種 JSON 網頁令牌（JWT）。 應用程式可以將此權杖的區段解碼，以索取已登入使用者的相關資訊。 key_id：一個唯一識別請求綁定的公鑰的字串。 若有錯誤： error：一串錯誤代碼字串，可用來分類發生的錯誤類型，並用來對錯誤做出反應。 error_description：一個特定的錯誤訊息，可以幫助開發者找出認證錯誤的根本原因。 error_codes：一份有助於診斷的 STS 專屬錯誤代碼清單。 時間戳記：錯誤發生的時間點。 trace_id：一個能協助診斷的唯一請求識別碼。 correlation_id：一個請求的唯一識別碼，有助於跨元件的診斷。 狀態：網路請求的回應狀態
ServerTelemetryEntity
ServerTelemetryRequest
ShrOptions
SignedHttpRequest
SignedHttpRequestParameters
StaticAuthorityOptions
StoreInCache	控制是否應該將標記儲存在快取中。 若設為 false，標記仍可被取得並回傳，但不會被快取以便日後取回。
StringDict	Key-Value 類型來支援 queryParams、extraQueryParams 及 claims
SubMeasurement
SystemOptions	用這個來設定 Configuration 物件中的憑證續約資訊 tokenRenewalOffsetSeconds - 設定到期前更新代幣所需的偏移時間窗口
TenantProfile	同一使用者的帳號細節在不同租戶間有所不同
ThrottlingEntity
TokenClaims	類型描述 MSAL 已知的 Id Token 聲明。
TokenKeys
AppTokenProviderParameters	IAppTokenProvider 擴充性輸入物件。 MSAL 會建立這個物件，可用來協助建立 AppTokenProviderResult。 correlationId-與請求相關的關聯 Id。 tenantId - 必須提供令牌的租戶 ID 範圍 - 必須提供令牌的範圍 主張 - 標記必須滿足的任何額外要求
AppTokenProviderResult	IAppTokenProvider 擴展性輸出物件。 accessToken - 實際的存取權杖，通常為 JWT 格式，滿足請求資料 AppTokenProviderParameters 過期秒數——代幣到期前還有多少時間，以秒數計。 類似於 AAD 代幣回應中的「expires_in」欄位。 refreshInSeconds - 代幣還有多久時間應該被主動刷新。 類似於 AAD 令牌回應中的「refresh_in」欄位。
ClientAssertion	機密客戶端的客戶端聲明憑證
ClientAssertionCallback
ClientAssertionConfig
CommonClientCredentialRequest	CommonClientCredentialRequest 範圍（scopes）-應用程式請求存取權限的範圍陣列。 authority - 權限機構的網址，即 MSAL 取得權杖的安全性憑證服務（STS）。 correlationId - 每個請求唯一的 GUID 設定，用於遠端追蹤請求以進行遙測。 skipCache - 跳過令牌快取查詢，強制請求權威取得新令牌。 預設為 False。 preferredAzureRegionOptions - 用戶偏好的 Azure 區域選項 tokenQueryParameters - 將自訂查詢參數的字串對字串映射到 /token 呼叫中
CommonDeviceCodeRequest	Oauth2 裝置程式碼流程的參數。 範圍（scopes）-應用程式請求存取權限的範圍陣列。 權限：- 權限機構的網址，即 MSAL 取得憑證的安全憑證服務（STS）。 如果 authority 是設定在用戶端應用程式物件上，這會覆蓋該值。 覆寫該數值每次都會進行權威驗證。 如果所有請求都使用相同的權限，請設定在應用程式物件上，而非請求本身。 correlationId - 每個請求唯一的 GUID 設定，用於遠端追蹤請求以進行遙測。 deviceCodeCallback - 包含裝置代碼回應的回調。 訊息應該會顯示給最終使用者。 最終使用者接著可以導航到verification_uri，輸入user_code並輸入憑證。 cancel - 布林值以取消裝置程式碼端點的輪詢。 當使用者在另一台裝置上進行認證時，MSAL 會輪詢安全令牌服務的憑證端點，時間間隔為裝置代碼回應中指定的間隔（通常為 15 分鐘）。 若要停止輪詢並取消請求，請設定 cancel=true。 resourceRequestMethod - 用於從資源請求資料的 HTTP 請求類型（例如「GET」、「POST」等）。 用於持有權證明流程。 resourceRequestUri - 該標記將用於的 URI。 用於持有權證明流程。 逾時 - 使用者明確設定用於輪詢裝置碼端點的秒數逾時時間。 在此期間結束時;假設裝置代碼尚未過期;裝置代碼輪詢會被停止，請求也被取消。 裝置代碼過期視窗在此期間內始終優先。 extraQueryParameters - 新增自訂查詢參數的字串到字串映射
CommonOnBehalfOfRequest	範圍（scopes）-應用程式請求存取權限的範圍陣列。 authority - 權限機構的網址，即 MSAL 取得權杖的安全性憑證服務（STS）。 correlationId - 每個請求唯一的 GUID 設定，用於遠端追蹤請求以進行遙測。 oboAssertion - 傳送到中階 API 的存取權杖。 此代幣必須有該應用程式的受眾，該 OBO 請求。 skipCache - 跳過令牌快取查詢，強制請求權威取得新令牌。 預設為 False。 tokenQueryParameters - 將自訂查詢參數的字串對字串映射到 /token 呼叫中
CommonUsernamePasswordRequest	CommonUsernamePassword 參數由使用者傳遞以取得憑證 注意：最新的 OAuth 2.0 安全最佳實務完全禁止密碼授權。 此流程是為了內部測試而新增。 範圍（scopes）-應用程式請求存取權限的範圍陣列。 claims - 一個嚴格的聲明請求，會被加入所有 /authorize 和 /token 呼叫中。 當靜默請求中包含快取查詢時，會跳過快取查找並刷新令牌。 authority - 應用程式取得代幣的權威的網址。 correlationId - 每個請求唯一的 GUID 設定，用於遠端追蹤請求以進行遙測。 用戶名 - 客戶端用戶名 密碼 - 憑證 tokenQueryParameters - 將自訂查詢參數的字串對字串映射到 /token 呼叫中
DeviceCodeResponse	DeviceCode 由安全令牌服務裝置代碼端點回傳，包含裝置代碼流程所需的資訊。 userCode：使用者在驗證 URI 認證時需提供的程式碼 deviceCode：應包含在存取權杖請求中的程式碼 驗證 URI：使用者可進行驗證的 URI expiresIn：裝置程式碼的過期時間（以秒計） 區間：STS 應在 輪詢的間隔 訊息：應顯示給使用者的訊息
NativeRequest
NativeSignOutRequest
ServerDeviceCodeResponse

列舉

LogLevel	日誌訊息層級。
PerformanceEventStatus	表演活動的狀況。
PerformanceEvents	透過 的操作列舉，其效能由 PerformanceClient 衡量。

函式

buildAccountToCache(CacheManager, Authority, string, (input: string) => string, string, TokenClaims, string, string, null | string, AuthorizationCodePayload, string, Logger)
buildClientInfo(string, (input: string) => string)	函式用來從伺服器 clientInfo 字串建立客戶端資訊物件
buildClientInfoFromHomeAccountId(string)	函式用來從快取的 homeAccountId 字串建立客戶端資訊物件
buildStaticAuthorityOptions(Partial<AuthorityOptions>)
buildTenantProfile(string, string, string, TokenClaims)	建構租戶檔案
createAuthError(string, string)
createCacheError(unknown)	輔助功能，將瀏覽器錯誤包裹在 CacheError 物件中
createClientAuthError(string, string)
createClientConfigurationError(string)
createInteractionRequiredAuthError(string)	產生一個互動必需的AuthError
createNetworkError(AuthError, number, Record<string, string>, Error)	為失敗的網路請求建立 NetworkError 物件
formatAuthorityUri(string)
getRequestThumbprint(string, BaseAuthRequest, string)
getTenantIdFromIdTokenClaims(TokenClaims)	從可用 ID 憑證權利要求取得 tenantId，並設定為憑證領域，優先順序如下： tid——如果代幣是從 Azure AD 租戶取得，TID 會存在 TFP——如果代幣是從現代 B2C 租戶取得，TFP 應該會存在 ACR - 若代幣是從舊有 B2C 租戶取得，ACR 應存在，並下級以符合領域大小差異的比較需求
tenantIdMatchesHomeTenant(string, string)	如果 tenantId 與 homeAccountID 的 utid 部分相符，則會回傳為真
updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)	將依租戶資料而異的帳戶資訊，這些資料來自 ID 代幣申訴，並用租戶專屬帳戶資訊取代

變數

AADAuthorityConstants	與 AAD 權威相關的字串常數
AuthenticationScheme	認證請求類型
AuthorityType	MSAL 支援的權威類型。
AzureCloudInstance
CacheAccountType	快取中的帳號類型
CacheOutcome	指定從身份提供者取得存取權杖的原因
CacheType	合併所有快取類型
CcsCredentialType
ClaimsRequestKeys	理賠申請金鑰
CredentialType	快取中儲存的憑證類型
EncodingTypes
GrantType	允許grant_type
HeaderNames	請求標頭名稱
HttpMethod
HttpStatus
JsonWebTokenTypes
OAuthResponseType	允許的值 response_type
PasswordGrantConstants	密碼授予參數
PersistentCacheKeys	持久快取金鑰為MSAL，使用者登入時會保留。
ProtocolMode	MSAL 支援的協定模式。
ResponseMode	允許的值為response_mode
ServerResponseType	伺服器回應類型的允許值
AuthErrorMessage	AuthErrorMessage 類別包含錯誤碼與訊息所使用的字串常數。
ClientAuthErrorMessage	錯誤碼與訊息所用的字串常數。
ClientConfigurationErrorMessage	ClientConfigurationErrorMessage 類別，包含錯誤碼與訊息所使用的字串常數。
CodeChallengeMethodValues	codeVerifier 允許的值
Constants
DEFAULT_CRYPTO_IMPLEMENTATION
DEFAULT_SYSTEM_OPTIONS
DEFAULT_TOKEN_RENEWAL_OFFSET_SEC
Errors
IntFields
InteractionRequiredAuthErrorMessage	互動需要依 SDK 定義的錯誤進行
OIDC_DEFAULT_SCOPES
ONE_DAY_IN_MS
PromptValue	我們曾考慮在請求中將「列舉」取代字串，但看起來允許的提示值清單在過去幾年一直在變動。 有些內部合作夥伴的提示值也未被記錄，因此選擇了通用的「字串」類型而非「列舉」
StubbedNetworkModule
THE_FAMILY_ID
ThrottlingConstants	與節流相關的常數
version

函式詳細資料

buildAccountToCache(CacheManager, Authority, string, (input: string) => string, string, TokenClaims, string, string, null | string, AuthorizationCodePayload, string, Logger)

function buildAccountToCache(cacheStorage: CacheManager, authority: Authority, homeAccountId: string, base64Decode: (input: string) => string, correlationId: string, idTokenClaims?: TokenClaims, clientInfo?: string, environment?: string, claimsTenantId?: null | string, authCodePayload?: AuthorizationCodePayload, nativeAccountId?: string, logger?: Logger): AccountEntity

參數

cacheStorage

CacheManager

authority

Authority

homeAccountId

string

base64Decode

(input: string) => string

correlationId

string

idTokenClaims

TokenClaims

clientInfo

string

environment

string

claimsTenantId

null | string

authCodePayload

AuthorizationCodePayload

nativeAccountId

string

logger

Logger

傳回

AccountEntity

buildClientInfo(string, (input: string) => string)

函式用來從伺服器 clientInfo 字串建立客戶端資訊物件

function buildClientInfo(rawClientInfo: string, base64Decode: (input: string) => string): ClientInfo

參數

rawClientInfo

string

base64Decode

(input: string) => string

傳回

ClientInfo

buildClientInfoFromHomeAccountId(string)

函式用來從快取的 homeAccountId 字串建立客戶端資訊物件

function buildClientInfoFromHomeAccountId(homeAccountId: string): ClientInfo

參數

homeAccountId

string

傳回

ClientInfo

buildStaticAuthorityOptions(Partial<AuthorityOptions>)

function buildStaticAuthorityOptions(authOptions: Partial<AuthorityOptions>): StaticAuthorityOptions

參數

authOptions

Partial<AuthorityOptions>

傳回

StaticAuthorityOptions

buildTenantProfile(string, string, string, TokenClaims)

建構租戶檔案

function buildTenantProfile(homeAccountId: string, localAccountId: string, tenantId: string, idTokenClaims?: TokenClaims): TenantProfile

參數

homeAccountId

string

此帳戶物件的家用帳戶識別碼

localAccountId

string

此帳戶物件的本地帳號識別器

tenantId

string

這個帳號所屬的完整租戶或組織識別碼

idTokenClaims

TokenClaims

來自 ID 代幣的主張

傳回

TenantProfile

createAuthError(string, string)

function createAuthError(code: string, additionalMessage?: string): AuthError

參數

code

string

additionalMessage

string

傳回

AuthError

createCacheError(unknown)

輔助功能，將瀏覽器錯誤包裹在 CacheError 物件中

function createCacheError(e: unknown): CacheError

參數

e

unknown

傳回

CacheError

createClientAuthError(string, string)

function createClientAuthError(errorCode: string, additionalMessage?: string): ClientAuthError

參數

errorCode

string

additionalMessage

string

傳回

ClientAuthError

createClientConfigurationError(string)

function createClientConfigurationError(errorCode: string): ClientConfigurationError

參數

errorCode

string

傳回

ClientConfigurationError

createInteractionRequiredAuthError(string)

產生一個互動必需的AuthError

function createInteractionRequiredAuthError(errorCode: string): InteractionRequiredAuthError

參數

errorCode

string

傳回

InteractionRequiredAuthError

createNetworkError(AuthError, number, Record<string, string>, Error)

為失敗的網路請求建立 NetworkError 物件

function createNetworkError(error: AuthError, httpStatus?: number, responseHeaders?: Record<string, string>, additionalError?: Error): NetworkError

參數

error

AuthError

錯誤會被拋回給來電者

httpStatus

number

網路請求的狀態碼

responseHeaders

Record<string, string>

網路請求的回應標頭（如有）

additionalError

Error

傳回

NetworkError

NetworkError 物件

formatAuthorityUri(string)

function formatAuthorityUri(authorityUri: string): string

參數

authorityUri

string

傳回

string

getRequestThumbprint(string, BaseAuthRequest, string)

function getRequestThumbprint(clientId: string, request: BaseAuthRequest, homeAccountId?: string): RequestThumbprint

參數

clientId

string

request

BaseAuthRequest

homeAccountId

string

傳回

RequestThumbprint

getTenantIdFromIdTokenClaims(TokenClaims)

從可用 ID 憑證權利要求取得 tenantId，並設定為憑證領域，優先順序如下：

1. tid——如果代幣是從 Azure AD 租戶取得，TID 會存在
2. TFP——如果代幣是從現代 B2C 租戶取得，TFP 應該會存在
3. ACR - 若代幣是從舊有 B2C 租戶取得，ACR 應存在，並下級以符合領域大小差異的比較需求

function getTenantIdFromIdTokenClaims(idTokenClaims?: TokenClaims): string | null

參數

idTokenClaims

TokenClaims

傳回

string | null

tenantIdMatchesHomeTenant(string, string)

如果 tenantId 與 homeAccountID 的 utid 部分相符，則會回傳為真

function tenantIdMatchesHomeTenant(tenantId?: string, homeAccountId?: string): boolean

參數

tenantId

string

homeAccountId

string

傳回

boolean

updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)

將依租戶資料而異的帳戶資訊，這些資料來自 ID 代幣申訴，並用租戶專屬帳戶資訊取代

function updateAccountTenantProfileData(baseAccountInfo: AccountInfo, tenantProfile?: TenantProfile, idTokenClaims?: TokenClaims, idTokenSecret?: string): AccountInfo

參數

baseAccountInfo

AccountInfo

tenantProfile

TenantProfile

idTokenClaims

TokenClaims

idTokenSecret

string

傳回

AccountInfo

變數詳細資料

AADAuthorityConstants

與 AAD 權威相關的字串常數

AADAuthorityConstants: { COMMON: "common", CONSUMERS: "consumers", ORGANIZATIONS: "organizations" }

類型

{ COMMON: "common", CONSUMERS: "consumers", ORGANIZATIONS: "organizations" }

AuthenticationScheme

認證請求類型

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

類型

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

AuthorityType

MSAL 支援的權威類型。

AuthorityType: { Adfs: 1, Ciam: 3, Default: 0, Dsts: 2 }

類型

{ Adfs: 1, Ciam: 3, Default: 0, Dsts: 2 }

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

CacheAccountType

快取中的帳號類型

CacheAccountType: { ADFS_ACCOUNT_TYPE: "ADFS", GENERIC_ACCOUNT_TYPE: "Generic", MSAV1_ACCOUNT_TYPE: "MSA", MSSTS_ACCOUNT_TYPE: "MSSTS" }

類型

{ ADFS_ACCOUNT_TYPE: "ADFS", GENERIC_ACCOUNT_TYPE: "Generic", MSAV1_ACCOUNT_TYPE: "MSA", MSSTS_ACCOUNT_TYPE: "MSSTS" }

CacheOutcome

指定從身份提供者取得存取權杖的原因

CacheOutcome: { CACHED_ACCESS_TOKEN_EXPIRED: "3", FORCE_REFRESH_OR_CLAIMS: "1", NOT_APPLICABLE: "0", NO_CACHED_ACCESS_TOKEN: "2", PROACTIVELY_REFRESHED: "4" }

類型

{ CACHED_ACCESS_TOKEN_EXPIRED: "3", FORCE_REFRESH_OR_CLAIMS: "1", NOT_APPLICABLE: "0", NO_CACHED_ACCESS_TOKEN: "2", PROACTIVELY_REFRESHED: "4" }

CacheType

合併所有快取類型

CacheType: { ACCESS_TOKEN: 2001, ADFS: 1001, APP_METADATA: 3001, GENERIC: 1004, ID_TOKEN: 2003, MSA: 1002, MSSTS: 1003, REFRESH_TOKEN: 2002, UNDEFINED: 9999 }

類型

{ ACCESS_TOKEN: 2001, ADFS: 1001, APP_METADATA: 3001, GENERIC: 1004, ID_TOKEN: 2003, MSA: 1002, MSSTS: 1003, REFRESH_TOKEN: 2002, UNDEFINED: 9999 }

CcsCredentialType

CcsCredentialType: { HOME_ACCOUNT_ID: "home_account_id", UPN: "UPN" }

類型

{ HOME_ACCOUNT_ID: "home_account_id", UPN: "UPN" }

ClaimsRequestKeys

理賠申請金鑰

ClaimsRequestKeys: { ACCESS_TOKEN: "access_token", XMS_CC: "xms_cc" }

類型

{ ACCESS_TOKEN: "access_token", XMS_CC: "xms_cc" }

CredentialType

快取中儲存的憑證類型

CredentialType: { ACCESS_TOKEN: "AccessToken", ACCESS_TOKEN_WITH_AUTH_SCHEME: "AccessToken_With_AuthScheme", ID_TOKEN: "IdToken", REFRESH_TOKEN: "RefreshToken" }

類型

{ ACCESS_TOKEN: "AccessToken", ACCESS_TOKEN_WITH_AUTH_SCHEME: "AccessToken_With_AuthScheme", ID_TOKEN: "IdToken", REFRESH_TOKEN: "RefreshToken" }

EncodingTypes

EncodingTypes: { BASE64: "base64", HEX: "hex", UTF8: "utf-8" }

類型

{ BASE64: "base64", HEX: "hex", UTF8: "utf-8" }

GrantType

允許grant_type

GrantType: { AUTHORIZATION_CODE_GRANT: "authorization_code", CLIENT_CREDENTIALS_GRANT: "client_credentials", DEVICE_CODE_GRANT: "device_code", IMPLICIT_GRANT: "implicit", JWT_BEARER: "urn:ietf:params:oauth:grant-type:jwt-bearer", REFRESH_TOKEN_GRANT: "refresh_token", RESOURCE_OWNER_PASSWORD_GRANT: "password" }

類型

{ AUTHORIZATION_CODE_GRANT: "authorization_code", CLIENT_CREDENTIALS_GRANT: "client_credentials", DEVICE_CODE_GRANT: "device_code", IMPLICIT_GRANT: "implicit", JWT_BEARER: "urn:ietf:params:oauth:grant-type:jwt-bearer", REFRESH_TOKEN_GRANT: "refresh_token", RESOURCE_OWNER_PASSWORD_GRANT: "password" }

HeaderNames

請求標頭名稱

HeaderNames: { AuthenticationInfo: "Authentication-Info", CCS_HEADER: "X-AnchorMailbox", CONTENT_LENGTH: "Content-Length", CONTENT_TYPE: "Content-Type", RETRY_AFTER: "Retry-After", WWWAuthenticate: "WWW-Authenticate", X_MS_HTTP_VERSION: "x-ms-httpver", X_MS_REQUEST_ID: "x-ms-request-id" }

類型

{ AuthenticationInfo: "Authentication-Info", CCS_HEADER: "X-AnchorMailbox", CONTENT_LENGTH: "Content-Length", CONTENT_TYPE: "Content-Type", RETRY_AFTER: "Retry-After", WWWAuthenticate: "WWW-Authenticate", X_MS_HTTP_VERSION: "x-ms-httpver", X_MS_REQUEST_ID: "x-ms-request-id" }

HttpMethod

HttpMethod: { GET: "GET", POST: "POST" }

類型

{ GET: "GET", POST: "POST" }

HttpStatus

HttpStatus: { BAD_REQUEST: 400, CLIENT_ERROR: 400, CLIENT_ERROR_RANGE_END: 499, CLIENT_ERROR_RANGE_START: 400, GATEWAY_TIMEOUT: 504, GONE: 410, MULTI_SIDED_ERROR: 600, NOT_FOUND: 404, REDIRECT: 302, REQUEST_TIMEOUT: 408, SERVER_ERROR: 500, SERVER_ERROR_RANGE_END: 599, SERVER_ERROR_RANGE_START: 500, SERVICE_UNAVAILABLE: 503, SUCCESS: 200, SUCCESS_RANGE_END: 299, SUCCESS_RANGE_START: 200, TOO_MANY_REQUESTS: 429, UNAUTHORIZED: 401 }

類型

{ BAD_REQUEST: 400, CLIENT_ERROR: 400, CLIENT_ERROR_RANGE_END: 499, CLIENT_ERROR_RANGE_START: 400, GATEWAY_TIMEOUT: 504, GONE: 410, MULTI_SIDED_ERROR: 600, NOT_FOUND: 404, REDIRECT: 302, REQUEST_TIMEOUT: 408, SERVER_ERROR: 500, SERVER_ERROR_RANGE_END: 599, SERVER_ERROR_RANGE_START: 500, SERVICE_UNAVAILABLE: 503, SUCCESS: 200, SUCCESS_RANGE_END: 299, SUCCESS_RANGE_START: 200, TOO_MANY_REQUESTS: 429, UNAUTHORIZED: 401 }

JsonWebTokenTypes

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

類型

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

OAuthResponseType

允許的值 response_type

OAuthResponseType: { CODE: "code", IDTOKEN_TOKEN: "id_token token", IDTOKEN_TOKEN_REFRESHTOKEN: "id_token token refresh_token" }

類型

{ CODE: "code", IDTOKEN_TOKEN: "id_token token", IDTOKEN_TOKEN_REFRESHTOKEN: "id_token token refresh_token" }

PasswordGrantConstants

密碼授予參數

PasswordGrantConstants: { password: "password", username: "username" }

類型

{ password: "password", username: "username" }

PersistentCacheKeys

持久快取金鑰為MSAL，使用者登入時會保留。

PersistentCacheKeys: { ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }

類型

{ ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }

ProtocolMode

MSAL 支援的協定模式。

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

類型

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

ResponseMode

允許的值為response_mode

ResponseMode: { FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }

類型

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

ServerResponseType

警告

此 API 現已淘汰。

Use ResponseMode instead

伺服器回應類型的允許值

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

類型

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

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

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

CodeChallengeMethodValues

codeVerifier 允許的值

CodeChallengeMethodValues: { PLAIN: string, S256: string }

類型

{ PLAIN: string, S256: string }

Constants

Constants: { AAD_INSTANCE_DISCOVERY_ENDPT: string, AAD_TENANT_DOMAIN_SUFFIX: string, ADFS: string, AUTHORIZATION_PENDING: string, AZURE_REGION_AUTO_DISCOVER_FLAG: string, CIAM_AUTH_URL: string, CLAIMS: string, CODE_GRANT_TYPE: string, CONSUMER_UTID: string, DEFAULT_AUTHORITY: string, DEFAULT_AUTHORITY_HOST: string, DEFAULT_COMMON_TENANT: string, DSTS: string, EMAIL_SCOPE: string, EMPTY_STRING: string, FORWARD_SLASH: string, IMDS_ENDPOINT: string, IMDS_TIMEOUT: number, IMDS_VERSION: string, INVALID_INSTANCE: string, KNOWN_PUBLIC_CLOUDS: string[], LIBRARY_NAME: string, NOT_APPLICABLE: string, NOT_AVAILABLE: string, NOT_DEFINED: string, NO_ACCOUNT: string, OFFLINE_ACCESS_SCOPE: string, OPENID_SCOPE: string, PROFILE_SCOPE: string, REGIONAL_AUTH_PUBLIC_CLOUD_SUFFIX: string, RESOURCE_DELIM: string, RT_GRANT_TYPE: string, S256_CODE_CHALLENGE_METHOD: string, SHR_NONCE_VALIDITY: number, SKU: string, URL_FORM_CONTENT_TYPE: string }

類型

{ AAD_INSTANCE_DISCOVERY_ENDPT: string, AAD_TENANT_DOMAIN_SUFFIX: string, ADFS: string, AUTHORIZATION_PENDING: string, AZURE_REGION_AUTO_DISCOVER_FLAG: string, CIAM_AUTH_URL: string, CLAIMS: string, CODE_GRANT_TYPE: string, CONSUMER_UTID: string, DEFAULT_AUTHORITY: string, DEFAULT_AUTHORITY_HOST: string, DEFAULT_COMMON_TENANT: string, DSTS: string, EMAIL_SCOPE: string, EMPTY_STRING: string, FORWARD_SLASH: string, IMDS_ENDPOINT: string, IMDS_TIMEOUT: number, IMDS_VERSION: string, INVALID_INSTANCE: string, KNOWN_PUBLIC_CLOUDS: string[], LIBRARY_NAME: string, NOT_APPLICABLE: string, NOT_AVAILABLE: string, NOT_DEFINED: string, NO_ACCOUNT: string, OFFLINE_ACCESS_SCOPE: string, OPENID_SCOPE: string, PROFILE_SCOPE: string, REGIONAL_AUTH_PUBLIC_CLOUD_SUFFIX: string, RESOURCE_DELIM: string, RT_GRANT_TYPE: string, S256_CODE_CHALLENGE_METHOD: string, SHR_NONCE_VALIDITY: number, SKU: string, URL_FORM_CONTENT_TYPE: string }

DEFAULT_CRYPTO_IMPLEMENTATION

DEFAULT_CRYPTO_IMPLEMENTATION: ICrypto

類型

ICrypto

DEFAULT_SYSTEM_OPTIONS

DEFAULT_SYSTEM_OPTIONS: Required<SystemOptions>

類型

Required<SystemOptions>

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC: 300

類型

300

Errors

Errors: { CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

類型

{ CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

IntFields

IntFields: ReadonlySet<string>

類型

ReadonlySet<string>

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

ONE_DAY_IN_MS

ONE_DAY_IN_MS: 86400000

類型

86400000

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 }

StubbedNetworkModule

StubbedNetworkModule: INetworkModule

類型

INetworkModule

THE_FAMILY_ID

THE_FAMILY_ID: "1"

類型

"1"

ThrottlingConstants

與節流相關的常數

ThrottlingConstants: { DEFAULT_MAX_THROTTLE_TIME_SECONDS: number, DEFAULT_THROTTLE_TIME_SECONDS: number, THROTTLING_PREFIX: string, X_MS_LIB_CAPABILITY_VALUE: string }

類型

{ DEFAULT_MAX_THROTTLE_TIME_SECONDS: number, DEFAULT_THROTTLE_TIME_SECONDS: number, THROTTLING_PREFIX: string, X_MS_LIB_CAPABILITY_VALUE: string }

version

version: "15.17.0"

類型

"15.17.0"