UserFederatedIdentityCredentialParameters クラス
- java.
lang. Object - com.
microsoft. aad. msal4j. UserFederatedIdentityCredentialParameters
- com.
実装
public class UserFederatedIdentityCredentialParameters
implements com.microsoft.aad.msal4j.IAcquireTokenParameters
ユーザー フェデレーション ID 資格情報 (user_fic) フローのパラメーターを含むオブジェクト。 これは、(Leg 2 から取得した) フェデレーション ID 資格情報がユーザー スコープ トークンと交換される、エージェント ID プロトコルの Leg 3 に使用されます。
パラメーターとして使用できます。 acquireToken(UserFederatedIdentityCredentialParameters parameters)
メソッドの概要
| 修飾子と型 | メソッドと説明 |
|---|---|
| java.lang.String | assertion() |
|
static
User |
builder(Set<String> scopes, String username, String assertion)
UPN (ユーザー プリンシパル名) を使用する UserFederatedIdentityCredentialParameters のビルダー。 |
|
static
User |
builder(Set<String> scopes, UUID userObjectId, String assertion)
ユーザー オブジェクト ID を使用する UserFederatedIdentityCredentialParameters のビルダー。 |
|
Claims |
claims()
認証要求と共に送信される要求要求パラメーターを取得します。 |
| java.lang.String |
clientClaims()
UserFederatedIdentityCredentialParametersBuilder#claimsFromClient(String)を介して設定されたクライアント側の要求。 |
| 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()
非推奨
IAcquireTokenParameters インターフェイス コントラクトを満たすためにのみ存在します。 使用は推奨されません。この API は、すべてのパラメーター クラスで削除がスケジュールされており、今後のリリースで新しいメカニズムに置き換えられます。
トークン要求に含める追加のクエリ パラメーターを取得します。 |
| boolean | forceRefresh() |
| java.util.Set<java.lang.String> |
scopes()
アクセス トークンに対して要求されたスコープ (アクセス許可) のセットを取得します。 |
| java.lang.String |
tenant()
トークン要求のテナント識別子を取得します。 |
| java.lang.String | username() |
| java.util.UUID | userObjectId() |
メソッドの継承元: java.lang.Object
メソッドの詳細
assertion
public String assertion()
返品:
builder
public static UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, String username, String assertion)
UPN (ユーザー プリンシパル名) を使用する UserFederatedIdentityCredentialParameters のビルダー。
パラメーター:
返品:
builder
public static UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, UUID userObjectId, String assertion)
ユーザー オブジェクト ID を使用する UserFederatedIdentityCredentialParameters のビルダー。
パラメーター:
返品:
claims
public ClaimsRequest claims()
認証要求と共に送信される要求要求パラメーターを取得します。
要求要求パラメーターは、トークンで返される特定の要求を要求したり、MFA 認証を要求したり、トークン発行の他の側面を制御したりするために使用できます。
clientClaims
public String clientClaims()
UserFederatedIdentityCredentialParametersBuilder#claimsFromClient(String)を介して設定されたクライアント側の要求。 OAuth claims パラメーターとしてトークン エンドポイントに転送され、個別の要求値が個別にキャッシュされるように拡張キャッシュ キーの一部として使用されます。
computeExtCacheKeyHash
public String computeExtCacheKeyHash()
すべてのキャッシュ キー コンポーネントから拡張キャッシュ キー ハッシュを計算します。存在しない場合は空の文字列を計算します。 パラメーターは構築後に変更できないため、結果はメモされます。
extraHttpHeaders
public Map<String,String> extraHttpHeaders()
トークン要求に含める追加の HTTP ヘッダーを取得します。
これらのヘッダーは、トークン エンドポイントに送信された HTTP 要求に追加されます。 これは、プロキシまたは診断目的でカスタム ヘッダーを必要とするシナリオに役立ちます。
extraQueryParameters
public Map<String,String> extraQueryParameters()
非推奨
トークン要求に含める追加のクエリ パラメーターを取得します。
これらのパラメーターは、承認エンドポイントとトークン エンドポイントへの要求でクエリ文字列に追加されます。 これは、ライブラリで明示的にサポートされていないカスタム パラメーターを必要とするシナリオに役立ちます。
forceRefresh
public boolean forceRefresh()
返品:
scopes
public Set<String> scopes()
アクセス トークンに対して要求されたスコープ (アクセス許可) のセットを取得します。
スコープは、アプリケーションがアクセスを要求しているアクセス許可を表します。
tenant
public String tenant()
トークン要求のテナント識別子を取得します。
この値を指定すると、アプリケーションの機関 URL で指定されたテナントがオーバーライドされます。 テナント ID (GUID)、ドメイン名、または "共通" や "組織" などの特別な値のいずれかを指定できます。
username
public String username()
返品:
userObjectId
public UUID userObjectId()
返品: