AuthorizationCodeParameters.AuthorizationCodeParametersBuilder クラス

  • java.lang.Object
    • com.microsoft.aad.msal4j.AuthorizationCodeParameters.AuthorizationCodeParametersBuilder

public static class AuthorizationCodeParameters.AuthorizationCodeParametersBuilder

メソッドの概要

修飾子と型 メソッドと説明
AuthorizationCodeParametersBuilder authorizationCode(String authorizationCode)

OAuth2.0 承認コード フローの最初の手順で取得した承認コード。

AuthorizationCodeParameters build()
AuthorizationCodeParametersBuilder claims(ClaimsRequest claims)

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

AuthorizationCodeParametersBuilder claimsFromClient(String claimsJson)

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

AuthorizationCodeParametersBuilder codeVerifier(String codeVerifier)

PKCE に使用されるコード検証ツール。

AuthorizationCodeParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

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

AuthorizationCodeParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

非推奨

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

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

AuthorizationCodeParametersBuilder redirectUri(URI redirectUri)

Azure ポータルに登録され、OAuth2.0 承認コード フローの最初の手順で使用されたリダイレクト URI。

AuthorizationCodeParametersBuilder scopes(Set<String> scopes)

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

AuthorizationCodeParametersBuilder 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

メソッドの詳細

authorizationCode

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder authorizationCode(String authorizationCode)

OAuth2.0 承認コード フローの最初の手順で取得した承認コード。 詳細については、https://aka.ms/msal4j-authorization-code-flow をご覧ください

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

パラメーター:

authorizationCode

build

public AuthorizationCodeParameters build()

claims

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder claims(ClaimsRequest claims)

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

パラメーター:

claims

claimsFromClient

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder claimsFromClient(String claimsJson)

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

クライアント要求は主に機密クライアント Web アプリを対象としていますが、 AuthorizationCodeParameters は PublicClientApplicationでも受け入れられているため、このメソッドもそこで表示されます。 同じキャッシュに関する注意事項は 、両方 のアプリケーションの種類に適用されます。クライアント要求で取得されたトークンは拡張キャッシュ キーの下に格納されますが、後の acquireTokenSilently 呼び出し ( SilentParameters を使用し、クライアント要求を実行することはできません) は、そのエントリと一致せず、代わりにクライアント要求なしで更新されます。 要求は、それらを設定する取得/引き換え呼び出しにのみ適用されます。それらを再度適用するには、サイレント更新に依存するのではなく、このビルダーを使用して引き換えます。

パラメーター:

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

返品:

このビルダー インスタンス

codeVerifier

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder codeVerifier(String codeVerifier)

PKCE に使用されるコード検証ツール。 詳細については、https://tools.ietf.org/html/rfc7636 をご覧ください

パラメーター:

codeVerifier

extraHttpHeaders

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

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

パラメーター:

extraHttpHeaders

extraQueryParameters


public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

非推奨

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

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

パラメーター:

extraQueryParameters

redirectUri

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder redirectUri(URI redirectUri)

Azure ポータルに登録され、OAuth2.0 承認コード フローの最初の手順で使用されたリダイレクト URI。 詳細については、https://aka.ms/msal4j-authorization-code-flow をご覧ください

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

パラメーター:

redirectUri

scopes

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder scopes(Set<String> scopes)

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

パラメーター:

scopes

tenant

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder tenant(String tenant)

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

パラメーター:

tenant

toString

public String toString()

上書き:

AuthorizationCodeParameters.AuthorizationCodeParametersBuilder.toString()

適用対象