ClientCredentialParameters.ClientCredentialParametersBuilder クラス

  • java.lang.Object
    • com.microsoft.aad.msal4j.ClientCredentialParameters.ClientCredentialParametersBuilder

public static class ClientCredentialParameters.ClientCredentialParametersBuilder

メソッドの概要

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

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

ClientCredentialParametersBuilder claimsFromClient(String claimsJson)

OAuth claims 要求パラメーターとしてトークン エンドポイントに転送するクライアント側の要求 (生の JSON オブジェクト文字列) を指定します。

ClientCredentialParametersBuilder clientCredential(IClientCredential clientCredential)

この要求のクライアント資格情報をオーバーライドします

ClientCredentialParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

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

ClientCredentialParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

非推奨

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

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

ClientCredentialParametersBuilder fmiPath(String fmiPath)

エージェント ID シナリオの FMI (フェデレーション マネージド ID) パスを設定します。

ClientCredentialParametersBuilder scopes(Set<String> scopes)

アプリケーションがアクセスを要求しているスコープ。

ClientCredentialParametersBuilder skipCache(Boolean skipCache)

要求がトークン キャッシュの調査をスキップする必要があるかどうかを示します。

ClientCredentialParametersBuilder tenant(String tenant)

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

java.lang.String toString()

メソッドの継承元: 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 ClientCredentialParameters build()

claims

public ClientCredentialParameters.ClientCredentialParametersBuilder claims(ClaimsRequest claims)

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

パラメーター:

claims

claimsFromClient

public ClientCredentialParameters.ClientCredentialParametersBuilder claimsFromClient(String claimsJson)

OAuth claims 要求パラメーターとしてトークン エンドポイントに転送するクライアント側の要求 (生の JSON オブジェクト文字列) を指定します。 claims(ClaimsRequest claims) (キャッシュをバイパスするサーバーによって発行された要求チャレンジ) とは異なり、クライアント要求で取得されたトークンはキャッシュされ、キャッシュ エントリは要求値に対してキー指定されるため、個別の要求値によって個別のキャッシュ エントリが生成されます。 キャッシュの断片化を回避するには、安定した非動的な値を使用します。 特定のトークンのすべての要求で同じ値を送信します。生の値はキャッシュ キーの一部であるため、変更または省略すると、要求が別のキャッシュ パーティションにルーティングされます。 空白の値は無視されます。無効な JSON オブジェクトが MsalClientExceptionをスローします。

パラメーター:

claimsJson - クライアント要求を含む有効な JSON オブジェクト文字列

返品:

ClientCredentialParameters の構築に使用できるビルダー

clientCredential

public ClientCredentialParameters.ClientCredentialParametersBuilder clientCredential(IClientCredential clientCredential)

この要求のクライアント資格情報をオーバーライドします

パラメーター:

clientCredential

extraHttpHeaders

public ClientCredentialParameters.ClientCredentialParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

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

パラメーター:

extraHttpHeaders

extraQueryParameters


public ClientCredentialParameters.ClientCredentialParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

非推奨

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

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

パラメーター:

extraQueryParameters

fmiPath

public ClientCredentialParameters.ClientCredentialParametersBuilder fmiPath(String fmiPath)

エージェント ID シナリオの FMI (フェデレーション マネージド ID) パスを設定します。 設定すると、fmi_pathはクライアント資格情報トークン要求の本文パラメーターとして送信され、結果のトークンのスコープを特定のエージェント ID にEntra IDに指示します。 また、トークンは拡張キャッシュ キーを使用してキャッシュされ、異なるエージェント ID のトークン間の競合を防ぎます。

パラメーター:

fmiPath - FMI パス値 (通常はエージェント アプリケーション ID)

返品:

ClientCredentialParameters の構築に使用できるビルダー

scopes

public ClientCredentialParameters.ClientCredentialParametersBuilder scopes(Set<String> scopes)

アプリケーションがアクセスを要求しているスコープ。

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

パラメーター:

scopes

skipCache

public ClientCredentialParameters.ClientCredentialParametersBuilder skipCache(Boolean skipCache)

要求がトークン キャッシュの調査をスキップする必要があるかどうかを示します。 既定値は false に設定されています。

パラメーター:

skipCache

tenant

public ClientCredentialParameters.ClientCredentialParametersBuilder tenant(String tenant)

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

パラメーター:

tenant

toString

public String toString()

上書き:

ClientCredentialParameters.ClientCredentialParametersBuilder.toString()

適用対象