DeviceCodeFlowParameters クラス

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

実装

com.microsoft.aad.msal4j.IAcquireTokenParameters

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

デバイス コード フローのパラメーターを含むオブジェクト。 acquireToken(DeviceCodeFlowParameters parameters)するパラメーターとして使用できます。 詳細については、https://aka.ms/msal4j-device-code をご覧ください

メソッドの概要

修飾子と型 メソッドと説明
static DeviceCodeFlowParametersBuilder builder(Set<String> scopes, Consumer<DeviceCode> deviceCodeConsumer)

Builder for DeviceCodeFlowParameters
ClaimsRequest claims()

認証要求と共に送信される要求要求パラメーターを取得します。
java.util.function.Consumer<DeviceCode> deviceCodeConsumer()
java.util.Map<java.lang.String,java.lang.String> extraHttpHeaders()

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

非推奨

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

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

アクセス トークンに対して要求されたスコープ (アクセス許可) のセットを取得します。
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 DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder builder(Set<String> scopes, Consumer<DeviceCode> deviceCodeConsumer)

Builder for DeviceCodeFlowParameters

パラメーター:

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

返品:

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

claims

public ClaimsRequest claims()

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

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

deviceCodeConsumer

public Consumer<DeviceCode> deviceCodeConsumer()

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

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

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

extraQueryParameters


public Map<String,String> extraQueryParameters()

非推奨

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

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

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

scopes

public Set<String> scopes()

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

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

tenant

public String tenant()

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

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

適用対象