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>