ClientCredentialParameters クラス

パッケージ:
com.microsoft.aad.msal4j
Maven 成果物:
com.microsoft.azure:msal4j:1.26.0
  • java.lang.Object
    • com.microsoft.aad.msal4j.ClientCredentialParameters

実装

com.microsoft.aad.msal4j.IAcquireTokenParameters

public class ClientCredentialParameters
implements com.microsoft.aad.msal4j.IAcquireTokenParameters

クライアント資格情報フローのパラメーターを含むオブジェクト。 パラメーターとして使用できます。 acquireToken(ClientCredentialParameters parameters)

メソッドの概要

修飾子と型 メソッドと説明
static ClientCredentialParametersBuilder builder(Set<String> scopes)

Builder for ClientCredentialParameters
ClaimsRequest claims()

認証要求と共に送信される要求要求パラメーターを取得します。
java.lang.String clientClaims()

ClientCredentialParametersBuilder#claimsFromClient(String)を介して設定されたクライアント側の要求。
IClientCredential clientCredential()
java.lang.String computeExtCacheKeyHash()

すべてのキャッシュ キー コンポーネントから拡張キャッシュ キー ハッシュを計算します。
java.util.Map<java.lang.String,java.lang.String> extraHttpHeaders()

トークン要求に含める追加の HTTP ヘッダーを取得します。
java.util.Map<java.lang.String,java.lang.String> extraQueryParameters()

非推奨

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

トークン要求に含める追加のクエリ パラメーターを取得します。
java.lang.String fmiPath()

エージェント ID シナリオの FMI (フェデレーション マネージド ID) パスを取得します。
java.util.Set<java.lang.String> scopes()

アクセス トークンに対して要求されたスコープ (アクセス許可) のセットを取得します。
java.lang.Boolean skipCache()
java.lang.String tenant()

トークン要求のテナント識別子を取得します。

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

メソッドの詳細

builder

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

Builder for ClientCredentialParameters

パラメーター:

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

返品:

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

claims

public ClaimsRequest claims()

認証要求と共に送信される要求要求パラメーターを取得します。

要求要求パラメーターは、トークンで返される特定の要求を要求したり、MFA 認証を要求したり、トークン発行の他の側面を制御したりするために使用できます。

clientClaims

public String clientClaims()

ClientCredentialParametersBuilder#claimsFromClient(String)を介して設定されたクライアント側の要求。 OAuth claims パラメーターとしてトークン エンドポイントに転送され、個別の要求値が個別にキャッシュされるように拡張キャッシュ キーの一部として使用されます。

clientCredential

public IClientCredential clientCredential()

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

すべてのキャッシュ キー コンポーネントから拡張キャッシュ キー ハッシュを計算します。 コンポーネントが存在しない場合は、空の文字列を返します。

ClientCredentialParameters は構築後に変更できないため、結果はメモされます。 キャッシュ書き込み (TokenCache) とキャッシュ読み取り (サイレント 参照) の両方で使用されます。

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

トークン要求に含める追加の HTTP ヘッダーを取得します。

これらのヘッダーは、トークン エンドポイントに送信された HTTP 要求に追加されます。 これは、プロキシまたは診断目的でカスタム ヘッダーを必要とするシナリオに役立ちます。

extraQueryParameters


public Map<String,String> extraQueryParameters()

非推奨

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

トークン要求に含める追加のクエリ パラメーターを取得します。

これらのパラメーターは、承認エンドポイントとトークン エンドポイントへの要求でクエリ文字列に追加されます。 これは、ライブラリで明示的にサポートされていないカスタム パラメーターを必要とするシナリオに役立ちます。

fmiPath

public String fmiPath()

エージェント ID シナリオの FMI (フェデレーション マネージド ID) パスを取得します。 設定すると、 fmi_path はクライアント資格情報トークン要求の本文パラメーターとして送信され、結果のトークンのスコープは特定のエージェント ID になります。

返品:

FMI パス、または設定されていない場合は null

scopes

public Set<String> scopes()

アクセス トークンに対して要求されたスコープ (アクセス許可) のセットを取得します。

スコープは、アプリケーションがアクセスを要求しているアクセス許可を表します。

skipCache

public Boolean skipCache()

tenant

public String tenant()

トークン要求のテナント識別子を取得します。

この値を指定すると、アプリケーションの機関 URL で指定されたテナントがオーバーライドされます。 テナント ID (GUID)、ドメイン名、または "共通" や "組織" などの特別な値のいずれかを指定できます。

適用対象