InteractiveRequestParameters.InteractiveRequestParametersBuilder クラス

  • java.lang.Object
    • com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder

public static class InteractiveRequestParameters.InteractiveRequestParametersBuilder

メソッドの概要

修飾子と型 メソッドと説明
InteractiveRequestParameters build()
InteractiveRequestParametersBuilder claims(ClaimsRequest claims)

OIDC 要求要求パラメーターを使用して要求する要求。標準要求とカスタム要求の要求を許可する

InteractiveRequestParametersBuilder claimsChallenge(String claimsChallenge)

トークン要求が失敗し、応答にチャレンジ文字列がある場合に使用されます

InteractiveRequestParametersBuilder domainHint(String domainHint)

ユーザーがサインインに使用するテナントまたはドメインに関するヒントを提供します。

InteractiveRequestParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

トークン要求にヘッダーを追加する

InteractiveRequestParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

非推奨

運用環境のシナリオでは推奨されません。 今後のリリースで削除される予定であり、動作は新しい API に置き換えられる可能性があります。

トークン要求にクエリ パラメーターを追加する

InteractiveRequestParametersBuilder httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds)

ライブラリが認証結果を待機する時間 (秒単位)。

InteractiveRequestParametersBuilder instanceAware(boolean instanceAware)

true に設定すると、承認結果にはユーザーのホーム クラウドの権限が含まれます。この機関は、アプリケーションで設定された権限ではなく、トークン要求に使用されます。

InteractiveRequestParametersBuilder loginHint(String loginHint)

ユーザー名/メール アドレスがわかっている場合は、ユーザーのサインイン ページのユーザー名/メール アドレス フィールドを事前に入力するために使用できます。

InteractiveRequestParametersBuilder prompt(Prompt prompt)

必要なユーザー操作の種類を示します。

InteractiveRequestParametersBuilder proofOfPossession(HttpMethod httpMethod, URI uri, String nonce)

この要求の PopParameters を設定します。これにより、要求はベアラー トークンではなく所有証明トークンを取得できます。

InteractiveRequestParametersBuilder redirectUri(URI redirectUri)

MSAL が AZURE AD によって返された承認コードをリッスンするリダイレクト URI。

InteractiveRequestParametersBuilder scopes(Set<String> scopes)

アプリケーションがアクセスを要求していて、ユーザーが同意するスコープ。

InteractiveRequestParametersBuilder systemBrowserOptions(SystemBrowserOptions systemBrowserOptions)

PublicSystemBrowserOptionsClientApplication で使用するを設定します。

InteractiveRequestParametersBuilder tenant(String tenant)

この要求の機関 URL のテナント値をオーバーライドします

java.lang.String toString()
InteractiveRequestParametersBuilder windowHandle(long windowHandle)

正しい親で UI 要素を開くために使用される親ウィンドウ ハンドル

メソッドの継承元: java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

メソッドの詳細

build

public InteractiveRequestParameters build()

claims

public InteractiveRequestParameters.InteractiveRequestParametersBuilder claims(ClaimsRequest claims)

OIDC 要求要求パラメーターを使用して要求する要求。標準要求とカスタム要求の要求を許可する

パラメーター:

claims

claimsChallenge

public InteractiveRequestParameters.InteractiveRequestParametersBuilder claimsChallenge(String claimsChallenge)

トークン要求が失敗し、応答にチャレンジ文字列がある場合に使用されます

パラメーター:

claimsChallenge

domainHint

public InteractiveRequestParameters.InteractiveRequestParametersBuilder domainHint(String domainHint)

ユーザーがサインインに使用するテナントまたはドメインに関するヒントを提供します。 ドメイン ヒントの値は、テナントの登録済みドメインです。

パラメーター:

domainHint

extraHttpHeaders

public InteractiveRequestParameters.InteractiveRequestParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

トークン要求にヘッダーを追加する

パラメーター:

extraHttpHeaders

extraQueryParameters


public InteractiveRequestParameters.InteractiveRequestParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

非推奨

運用環境のシナリオでは推奨されません。 今後のリリースで削除される予定であり、動作は新しい API に置き換えられる可能性があります。

トークン要求にクエリ パラメーターを追加する

パラメーター:

extraQueryParameters

httpPollingTimeoutInSeconds

public InteractiveRequestParameters.InteractiveRequestParametersBuilder httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds)

ライブラリが認証結果を待機する時間 (秒単位)。 既定のタイムアウトは 120 秒です。

このタイムアウトが 0 以下に設定されている場合は無視され、ライブラリでは代わりに 1 秒のタイムアウトが使用されます

パラメーター:

httpPollingTimeoutInSeconds

instanceAware

public InteractiveRequestParameters.InteractiveRequestParametersBuilder instanceAware(boolean instanceAware)

true に設定すると、承認結果にはユーザーのホーム クラウドの権限が含まれます。この機関は、アプリケーションで設定された権限ではなく、トークン要求に使用されます。

パラメーター:

instanceAware

loginHint

public InteractiveRequestParameters.InteractiveRequestParametersBuilder loginHint(String loginHint)

ユーザー名/メール アドレスがわかっている場合は、ユーザーのサインイン ページのユーザー名/メール アドレス フィールドを事前に入力するために使用できます。 多くの場合、アプリは再認証時にこのパラメーターを使用します。これは、preferred_username要求を使用して以前のサインインからユーザー名を既に抽出しています。

パラメーター:

loginHint

prompt

public InteractiveRequestParameters.InteractiveRequestParametersBuilder prompt(Prompt prompt)

必要なユーザー操作の種類を示します。

パラメーター:

prompt

proofOfPossession

public InteractiveRequestParameters.InteractiveRequestParametersBuilder proofOfPossession(HttpMethod httpMethod, URI uri, String nonce)

この要求の PopParameters を設定し、要求がベアラー トークンではなく所有証明トークンを取得できるようにします。

詳細については、 PopParameters および https://aka.ms/msal4j-pop

パラメーター:

httpMethod - 有効な HTTP メソッド ("GET" や "POST" など)
uri - アプリケーションがアクセスしようとしているダウンストリームで保護された API 上の URI (例: https://graph.microsoft.com/beta/me/profile
nonce - リソース (たとえば、Microsoft Graph) を呼び出し、認証されていないリソースを呼び出し、pop 認証スキームに関連付けられている WWW-Authenticate ヘッダーを解析し、nonce パラメーターを抽出するか、後続の呼び出しで、Autheticate-Info ヘッダーを解析して nextnonce パラメーターを抽出することによって取得した文字列。

redirectUri

public InteractiveRequestParameters.InteractiveRequestParametersBuilder redirectUri(URI redirectUri)

MSAL が AZURE AD によって返された承認コードをリッスンするリダイレクト URI。 ポートが指定されたループバック アドレスである必要があります (例: http://localhost:3671). ポートが指定されていない場合、MSAL は開いているポートを見つけます。 詳細については、https://aka.ms/msal4j-interactive-requestを参照してください。

null にすることはできません。

パラメーター:

redirectUri

scopes

public InteractiveRequestParameters.InteractiveRequestParametersBuilder scopes(Set<String> scopes)

アプリケーションがアクセスを要求していて、ユーザーが同意するスコープ。

パラメーター:

scopes

systemBrowserOptions

public InteractiveRequestParameters.InteractiveRequestParametersBuilder systemBrowserOptions(SystemBrowserOptions systemBrowserOptions)

PublicClientApplication で使用する SystemBrowserOptions を設定します。

パラメーター:

systemBrowserOptions

tenant

public InteractiveRequestParameters.InteractiveRequestParametersBuilder tenant(String tenant)

この要求の機関 URL のテナント値をオーバーライドします

パラメーター:

tenant

toString

public String toString()

上書き:

InteractiveRequestParameters.InteractiveRequestParametersBuilder.toString()

windowHandle

public InteractiveRequestParameters.InteractiveRequestParametersBuilder windowHandle(long windowHandle)

正しい親で UI 要素を開くために使用される親ウィンドウ ハンドル

ブラウザー シナリオとコンソール アプリケーションWindows場合は、この値を設定する必要はありません

Windowsコンソール アプリケーションの場合、このパラメーターが設定されていない場合、MSAL Javaはコンソールのウィンドウ ハンドルの検出を試みます

MSAL Javaが UI 要素を開く (MSALRuntime を使用する場合など) シナリオでは、このパラメーターが必要であり、設定されていない場合は例外がスローされます

パラメーター:

windowHandle

適用対象