InteractiveBrowserCredential class

パッケージ:

@azure/identity

対話型ログイン フローを使用して、Web ブラウザー内で認証を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 では、この資格情報の 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 セキュリティで保護されたログイン ページにリダイレクトすることで認証を行うことができます。これにより、認証が開始された 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 では、この資格情報の 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>