InteractiveBrowserCredentialInBrowserOptions interface
InteractiveBrowserCredential クラスの一般的なオプションを定義します。
- Extends
プロパティ
client |
テナント内のアプリの登録のクライアント (アプリケーション) ID。 このパラメーターはブラウザーで必要です。 |
login |
loginHint を使用すると、対話型ログイン用にユーザー名を事前に選択できます。 このオプションを設定すると、アカウント選択プロンプトがスキップされ、指定されたアカウントですぐにログインが試行されます。 |
login |
リダイレクトまたはポップアップ ウィンドウを使用してユーザー認証フローを開始するかどうかを指定します。 指定できる値は、ブラウザーの場合は "redirect" または "popup" (既定値)、ノードの場合は "popup" (既定値) です。 |
redirect |
アプリケーションのリダイレクト URI を取得します。 これは、アプリケーション登録ポータルの値と同じである必要があります。 既定値は |
tenant |
Microsoft Entra テナント (ディレクトリ) ID。 |
継承されたプロパティ
additionally |
マルチテナント アプリケーションの場合は、資格情報がトークンを取得できる追加のテナントを指定します。 ワイルドカード値 "*" を追加して、アプリケーションがインストールされている任意のテナントのトークンを資格情報で取得できるようにします。 |
additional |
HTTP パイプラインに含める追加のポリシー。 |
allow |
要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します |
authentication |
個々のアカウントのキャッシュされた資格情報を取得するために使用できる以前の認証の結果。 これは、アプリケーションがクライアント ID とテナント ID のペアごとに複数のアカウントを操作する場合に必要です。 このレコードは、次のように資格情報の
|
authority |
認証要求に使用する機関ホスト。 使用可能な値は、 AzureAuthorityHosts を使用して使用できます。 既定値は "https://login.microsoftonline.com" です。 |
disable |
手動認証が必要な場合に getToken スローを行います。
開発者は を呼び出 |
disable |
フィールドは、認証を試みるときにインスタンス検出を実行するかどうかを決定します。
これを に |
http |
HTTP 要求の送信に使用される HttpClient。 |
logging |
ユーザーがログ ポリシー オプションの設定を構成し、アカウント情報のログ記録と、カスタマー サポートの個人を特定できる情報を許可できるようにします。 |
proxy |
送信要求のプロキシを構成するためのオプション。 |
redirect |
リダイレクト応答の処理方法のオプション。 |
retry |
失敗した要求を再試行する方法を制御するオプション。 |
telemetry |
一般的なテレメトリとトレース情報を送信要求に設定するためのオプション。 |
tls |
TLS 認証を構成するためのオプション |
user |
送信要求にユーザー エージェントの詳細を追加するためのオプション。 |
プロパティの詳細
clientId
テナント内のアプリの登録のクライアント (アプリケーション) ID。 このパラメーターはブラウザーで必要です。
clientId: string
プロパティ値
string
loginHint
loginHint を使用すると、対話型ログイン用にユーザー名を事前に選択できます。 このオプションを設定すると、アカウント選択プロンプトがスキップされ、指定されたアカウントですぐにログインが試行されます。
loginHint?: string
プロパティ値
string
loginStyle
リダイレクトまたはポップアップ ウィンドウを使用してユーザー認証フローを開始するかどうかを指定します。 指定できる値は、ブラウザーの場合は "redirect" または "popup" (既定値)、ノードの場合は "popup" (既定値) です。
loginStyle?: BrowserLoginStyle
プロパティ値
redirectUri
アプリケーションのリダイレクト URI を取得します。 これは、アプリケーション登録ポータルの値と同じである必要があります。 既定値は window.location.href
です。
このフィールドは、Node.js では不要になりました。
redirectUri?: string | () => string
プロパティ値
string | () => string
tenantId
Microsoft Entra テナント (ディレクトリ) ID。
tenantId?: string
プロパティ値
string
継承されたプロパティの詳細
additionallyAllowedTenants
マルチテナント アプリケーションの場合は、資格情報がトークンを取得できる追加のテナントを指定します。 ワイルドカード値 "*" を追加して、アプリケーションがインストールされている任意のテナントのトークンを資格情報で取得できるようにします。
additionallyAllowedTenants?: string[]
プロパティ値
string[]
InteractiveCredentialOptions.additionallyAllowedTenantsから継承されます
additionalPolicies
HTTP パイプラインに含める追加のポリシー。
additionalPolicies?: AdditionalPolicyConfig[]
プロパティ値
allowInsecureConnection
要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します
allowInsecureConnection?: boolean
プロパティ値
boolean
authenticationRecord
個々のアカウントのキャッシュされた資格情報を取得するために使用できる以前の認証の結果。 これは、アプリケーションがクライアント ID とテナント ID のペアごとに複数のアカウントを操作する場合に必要です。
このレコードは、次のように資格情報の authenticate()
メソッドを呼び出すことによって取得できます。
const authenticationRecord = await credential.authenticate();
authenticationRecord?: AuthenticationRecord
プロパティ値
authorityHost
認証要求に使用する機関ホスト。 使用可能な値は、 AzureAuthorityHosts を使用して使用できます。 既定値は "https://login.microsoftonline.com" です。
authorityHost?: string
プロパティ値
string
disableAutomaticAuthentication
手動認証が必要な場合に getToken スローを行います。
開発者は を呼び出 authenticate()
して、手動で認証するタイミングを制御する必要があります。
disableAutomaticAuthentication?: boolean
プロパティ値
boolean
InteractiveCredentialOptions.disableAutomaticAuthenticationから継承
disableInstanceDiscovery
フィールドは、認証を試みるときにインスタンス検出を実行するかどうかを決定します。
これを に true
設定すると、インスタンスの検出と機関の検証の両方が完全に無効になります。
その結果、構成された機関ホストが有効で信頼できることを確認することが重要です。
この機能は、プライベート クラウドや Azure Stack など、メタデータ エンドポイントに到達できないシナリオでの使用を目的としています。
インスタンス検出のプロセスでは、 から https://login.microsoft.com/ 機関メタデータを取得して機関を検証する必要があります。
disableInstanceDiscovery?: boolean
プロパティ値
boolean
httpClient
HTTP 要求の送信に使用される HttpClient。
httpClient?: HttpClient
プロパティ値
loggingOptions
ユーザーがログ ポリシー オプションの設定を構成し、アカウント情報のログ記録と、カスタマー サポートの個人を特定できる情報を許可できるようにします。
loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }
プロパティ値
LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }
proxyOptions
送信要求のプロキシを構成するためのオプション。
proxyOptions?: ProxySettings
プロパティ値
redirectOptions
リダイレクト応答の処理方法のオプション。
redirectOptions?: RedirectPolicyOptions
プロパティ値
retryOptions
失敗した要求を再試行する方法を制御するオプション。
retryOptions?: PipelineRetryOptions
プロパティ値
telemetryOptions
一般的なテレメトリとトレース情報を送信要求に設定するためのオプション。
telemetryOptions?: TelemetryOptions
プロパティ値
tlsOptions
TLS 認証を構成するためのオプション
tlsOptions?: TlsSettings
プロパティ値
userAgentOptions
送信要求にユーザー エージェントの詳細を追加するためのオプション。
userAgentOptions?: UserAgentPolicyOptions