InteractiveBrowserCredential class

套件:

@azure/identity

啟用驗證，以使用互動式登入流程在網頁瀏覽器內 Microsoft Entra ID。

建構函式

InteractiveBrowserCredential(InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

使用所需的詳細數據，建立 InteractiveBrowserCredential 的實例。 此認證會使用 授權碼流程。 在 Node.js 上，它會在接聽來自驗證服務的重新導向回應時開啟瀏覽器視窗。 在瀏覽器上，它會透過彈出視窗進行驗證。 loginStyle選擇性參數可以設定為 redirect ，藉由將使用者重新導向至 Azure 安全登入頁面來進行驗證，然後將使用者重新導向回驗證啟動所在的 Web 應用程式。 針對 Node.js，如果clientId已提供 ，則 Microsoft Entra 應用程式必須設定為具有「行動和桌面應用程式」重新導向端點。 請遵循我們的指南， 針對呼叫 Web API 的桌面應用程式設定重新導向 URI。

方法

authenticate(string | string[], GetTokenOptions)	使用 Microsoft Entra ID 進行驗證，並在成功時傳回存取令牌。 如果驗證失敗，將會擲回 CredentialUnavailableError 並顯示失敗的詳細數據。 如果無法以無訊息方式擷取令牌，此方法將需要用戶互動來擷取令牌。 在 Node.js 上，此認證預設會啟用 程式代碼交換的證明密鑰 (PKCE) 。 PKCE 是可減輕驗證程式代碼攔截攻擊的安全性功能。
getToken(string | string[], GetTokenOptions)	使用 Microsoft Entra ID 進行驗證，並在成功時傳回存取令牌。 如果驗證失敗，將會擲回 CredentialUnavailableError 並顯示失敗的詳細數據。 如果使用者提供 選項 disableAutomaticAuthentication，一旦無法以無訊息方式擷取令牌，此方法就不會嘗試要求用戶互動以擷取令牌。

建構函式詳細資料

InteractiveBrowserCredential(InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

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

此認證會使用 授權碼流程。 在 Node.js 上，它會在接聽來自驗證服務的重新導向回應時開啟瀏覽器視窗。 在瀏覽器上，它會透過彈出視窗進行驗證。 loginStyle選擇性參數可以設定為 redirect ，藉由將使用者重新導向至 Azure 安全登入頁面來進行驗證，然後將使用者重新導向回驗證啟動所在的 Web 應用程式。

針對 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 上，此認證預設會啟用 程式代碼交換的證明密鑰 (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>