AuthorizationRequestUrlParameters.Builder クラス

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

public static class AuthorizationRequestUrlParameters.Builder

コンストラクターの概要

コンストラクター 説明
Builder()

メソッドの概要

修飾子と型 メソッドと説明
AuthorizationRequestUrlParameters build()
Builder claims(ClaimsRequest val)

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

Azure AD テナント管理者が条件付きアクセス ポリシーを有効にしていて、ポリシーが満たされていない場合、MsalServiceExceptionには同意が必要な要求が含まれます。
Builder codeChallenge(String val)

Proof of Key for Code Exchange (PKCE) を使用して承認コード付与をセキュリティで保護するために使用されます。
Builder codeChallengeMethod(String val)

コード チャレンジ パラメーターのコード検証ツールをエンコードするために使用されるメソッド。
Builder correlationId(String val)

テレメトリの目的で要求を関連付けるために使用される識別子。
Builder domainHint(String val)

ユーザーがサインインに使用するテナントまたはドメインに関するヒントを提供します。
Builder extraQueryParameters(Map<String,String> val)

既に指定されているパラメーターの一覧に加えて、要求に追加できるクエリ パラメーター。
Builder extraScopesToConsent(Set<String> val)

アプリケーションがアクセスを要求しているスコープに加えて、エンド ユーザーに事前に同意を要求できるスコープ。
Builder instanceAware(boolean val)

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

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

要求に含まれ、トークンの応答としても返される値。
Builder prompt(Prompt val)

ユーザーとの必要な対話の種類を指定します。
Builder redirectUri(String val)

アプリケーションが認証応答を受信できるリダイレクト URI。
Builder responseMode(ResponseMode val)

認証結果をアプリに送信するために使用する方法を指定します。
Builder scopes(Set<String> val)

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

要求に含まれ、トークンの応答としても返される値。

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

メソッドの詳細

build

public AuthorizationRequestUrlParameters build()

claims

public AuthorizationRequestUrlParameters.Builder claims(ClaimsRequest val)

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

パラメーター:

val

claimsChallenge

public AuthorizationRequestUrlParameters.Builder claimsChallenge(String val)

Azure AD テナント管理者が条件付きアクセス ポリシーを有効にしていて、ポリシーが満たされていない場合、MsalServiceExceptionには同意が必要な要求が含まれます。

パラメーター:

val

codeChallenge

public AuthorizationRequestUrlParameters.Builder codeChallenge(String val)

Proof of Key for Code Exchange (PKCE) を使用して承認コード付与をセキュリティで保護するために使用されます。 codeChallenge が含まれている場合は必須。 詳細については、PKCE RCF を参照してください。 https://tools.ietf.org/html/rfc7636

パラメーター:

val

codeChallengeMethod

public AuthorizationRequestUrlParameters.Builder codeChallengeMethod(String val)

コード チャレンジ パラメーターのコード検証ツールをエンコードするために使用されるメソッド。 プレーンまたは S256 のいずれかです。 除外した場合、コード チャレンジはプレーンテキストと見なされます。 詳細については、PKCE RCF を参照してください。 https://tools.ietf.org/html/rfc7636

パラメーター:

val

correlationId

public AuthorizationRequestUrlParameters.Builder correlationId(String val)

テレメトリの目的で要求を関連付けるために使用される識別子。 通常は GUID です。

パラメーター:

val

domainHint

public AuthorizationRequestUrlParameters.Builder domainHint(String val)

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

パラメーター:

val

extraQueryParameters

public AuthorizationRequestUrlParameters.Builder extraQueryParameters(Map<String,String> val)

既に指定されているパラメーターの一覧に加えて、要求に追加できるクエリ パラメーター。

パラメーター:

val

extraScopesToConsent

public AuthorizationRequestUrlParameters.Builder extraScopesToConsent(Set<String> val)

アプリケーションがアクセスを要求しているスコープに加えて、エンド ユーザーに事前に同意を要求できるスコープ。

パラメーター:

val

instanceAware

public AuthorizationRequestUrlParameters.Builder instanceAware(boolean val)

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

パラメーター:

val

loginHint

public AuthorizationRequestUrlParameters.Builder loginHint(String val)

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

パラメーター:

val

nonce

public AuthorizationRequestUrlParameters.Builder nonce(String val)

要求に含まれ、トークンの応答としても返される値。 ランダムに生成された一意の値は、通常、クロスサイト リクエスト フォージェリ攻撃を防ぐために使用されます。

パラメーター:

val

prompt

public AuthorizationRequestUrlParameters.Builder prompt(Prompt val)

ユーザーとの必要な対話の種類を指定します。 使用可能な値は次のとおりです。 Prompt

パラメーター:

val

redirectUri

public AuthorizationRequestUrlParameters.Builder redirectUri(String val)

アプリケーションが認証応答を受信できるリダイレクト URI。 Azure ポータルに登録されているリダイレクト URI のいずれかと完全に一致している必要があります。

パラメーター:

val

responseMode

public AuthorizationRequestUrlParameters.Builder responseMode(ResponseMode val)

認証結果をアプリに送信するために使用する方法を指定します。

パラメーター:

val

scopes

public AuthorizationRequestUrlParameters.Builder scopes(Set<String> val)

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

パラメーター:

val

state

public AuthorizationRequestUrlParameters.Builder state(String val)

要求に含まれ、トークンの応答としても返される値。 ランダムに生成された一意の値は、通常、クロスサイト リクエスト フォージェリ攻撃を防ぐために使用されます。 状態は、認証要求が発生する前のアプリ内のユーザーの状態に関する情報をエンコードするためにも使用されます。

パラメーター:

val

適用対象