InteractiveBrowserCredentialInBrowserOptions interface
InteractiveBrowserCredential クラスの共通オプションを定義します。
- Extends
プロパティ
| client |
ユーザーがサインインする Microsoft Entra アプリケーションのクライアント ID。 このパラメーターはブラウザーで必要です。 開発者は、アプリケーションを登録し、適切なロールを割り当てる必要があります。 詳細については、https://aka.ms/identity/AppRegistrationAndRoleAssignmentを参照してください。 |
| 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
ユーザーがサインインする Microsoft Entra アプリケーションのクライアント ID。 このパラメーターはブラウザーで必要です。 開発者は、アプリケーションを登録し、適切なロールを割り当てる必要があります。 詳細については、https://aka.ms/identity/AppRegistrationAndRoleAssignmentを参照してください。
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[]
additionalPolicies
HTTP パイプラインに含める追加のポリシー。
additionalPolicies?: AdditionalPolicyConfig[]プロパティ値
interactiveCredentialOptions.additionalPolicies から継承
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