InteractiveBrowserCredential class

透過互動式登入流程,在網頁瀏覽器內啟用 Microsoft Entra ID 的認證。

建構函式

InteractiveBrowserCredential(InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

使用所需的詳細數據,建立 InteractiveBrowserCredential 的實例。

此認證會使用 授權碼流程。 在 Node.js上,它會在接聽來自驗證服務的重新導向回應時開啟瀏覽器視窗。 在瀏覽器中,它會透過快顯進行驗證。 loginStyle 可選參數設定為 redirect,透過將使用者導向Azure安全的登入頁面來驗證,該頁面會將使用者導回驗證開始的網頁應用程式。

Node.js,若提供 clientId,Microsoft Entra應用程式需設定為「行動與桌面應用程式」轉址端點。 請遵循我們的指南,設定呼叫 Web API傳統型應用程式的重新導向 URI。

方法

authenticate(string | string[], GetTokenOptions)

使用 Microsoft Entra ID 驗證,成功時回傳存取權杖。 如果驗證失敗,CredentialUnavailableError 將會擲回失敗的詳細數據。

如果無法以無訊息方式擷取令牌,此方法一律會為用戶產生挑戰。

在 Node.js上,此憑證預設啟用了 Proof Key for Code Exchange (PKCE)。 PKCE 是可減輕驗證程式代碼攔截攻擊的安全性功能。

getToken(string | string[], GetTokenOptions)

使用 Microsoft Entra ID 驗證,成功時回傳存取權杖。 如果驗證失敗,CredentialUnavailableError 將會擲回失敗的詳細數據。

如果使用者提供選項 disableAutomaticAuthentication,一旦無法以無訊息方式擷取令牌,此方法就不會嘗試要求用戶互動以擷取令牌。

建構函式詳細資料

InteractiveBrowserCredential(InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

使用所需的詳細數據,建立 InteractiveBrowserCredential 的實例。

此認證會使用 授權碼流程。 在 Node.js上,它會在接聽來自驗證服務的重新導向回應時開啟瀏覽器視窗。 在瀏覽器中,它會透過快顯進行驗證。 loginStyle 可選參數設定為 redirect,透過將使用者導向Azure安全的登入頁面來驗證,該頁面會將使用者導回驗證開始的網頁應用程式。

Node.js,若提供 clientId,Microsoft Entra應用程式需設定為「行動與桌面應用程式」轉址端點。 請遵循我們的指南,設定呼叫 Web API傳統型應用程式的重新導向 URI。

new InteractiveBrowserCredential(options: InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

參數

options

InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions

設定發出驗證要求之客戶端的選項。

方法詳細資料

authenticate(string | string[], GetTokenOptions)

使用 Microsoft Entra ID 驗證,成功時回傳存取權杖。 如果驗證失敗,CredentialUnavailableError 將會擲回失敗的詳細數據。

如果無法以無訊息方式擷取令牌,此方法一律會為用戶產生挑戰。

在 Node.js上,此憑證預設啟用了 Proof Key for Code Exchange (PKCE)。 PKCE 是可減輕驗證程式代碼攔截攻擊的安全性功能。

function authenticate(scopes: string | string[], options?: GetTokenOptions): Promise<undefined | AuthenticationRecord>

參數

scopes

string | string[]

令牌將具有存取權的範圍清單。

options
GetTokenOptions

用來設定此 TokenCredential 實作可能提出的任何要求的選項。

傳回

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

使用 Microsoft Entra ID 驗證,成功時回傳存取權杖。 如果驗證失敗,CredentialUnavailableError 將會擲回失敗的詳細數據。

如果使用者提供選項 disableAutomaticAuthentication,一旦無法以無訊息方式擷取令牌,此方法就不會嘗試要求用戶互動以擷取令牌。

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

參數

scopes

string | string[]

令牌將具有存取權的範圍清單。

options
GetTokenOptions

用來設定此 TokenCredential 實作可能提出的任何要求的選項。

傳回

Promise<AccessToken>