TokenRequestContext クラス

  • リファレンス
パッケージ:
com.azure.core.credential
Maven 成果物:
com.azure:azure-core:1.46.0
  • java.lang.Object
    • com.azure.core.credential.TokenRequestContext

public class TokenRequestContext

TokenRequestContextは、認証ソースからアクセス トークンを要求するときに追加情報とコンテキストを提供するために使用されるクラスです。 これにより、トークン要求をカスタマイズし、スコープ、要求、認証オプションなどの追加のパラメーターを指定できます。

TokenRequestContextは通常、Azure Active Directory (Azure AD) 認証など、より高度な構成またはオプションを必要とする認証メカニズムで使用されます。

の使用方法の概要を次に示します TokenRequestContext。

  1. クラスのインスタンスを TokenRequestContext 作成し、必要なプロパティを構成します。 TokenRequestContextクラスを使用すると、アクセス トークンを要求するスコープまたはリソース、および追加の要求またはオプションを指定できます。
  2. アクセス トークンを要求するときに、TokenRequestContext インスタンスを適切な認証クライアントまたはメカニズムに渡します。 これを行う特定の方法または API は、使用している認証メカニズムによって異なります。 たとえば、AAD 認証に Azure Identity を使用している場合は、TokenRequestContext インスタンスを実装の getToken メソッドに TokenCredential 渡します。
  3. 認証クライアントまたはメカニズムはトークン要求を処理し、Azure サービスへの要求の認証と承認に使用できるアクセス トークンを返します。

コンストラクターの概要

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

トークン要求インスタンスを作成します。

メソッドの概要

修飾子と型 メソッドと説明
TokenRequestContext addScopes(String[] scopes)

要求スコープに 1 つ以上のスコープを追加します。
String getClaims()

トークンに含める追加の要求を取得します。
List<String> getScopes()

トークンに必要なスコープを取得します。
String getTenantId()

認証要求に使用するテナント ID を取得します。
boolean isCaeEnabled()

要求されたトークンに対して継続的アクセス評価 (CAE) が有効になっているかどうかを示す状態を取得します。
TokenRequestContext setCaeEnabled(boolean enableCae)

要求されたトークンに対して継続的アクセス評価 (CAE) を有効にするかどうかを示します。
TokenRequestContext setClaims(String claims)

トークンに含める追加の要求を設定します。
TokenRequestContext setScopes(List<String> scopes)

トークンに必要なスコープを設定します。
TokenRequestContext setTenantId(String tenantId)

認証要求に使用するテナント ID を設定します。

メソッドの継承元: java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

コンストラクターの詳細

TokenRequestContext

public TokenRequestContext()

トークン要求インスタンスを作成します。

メソッドの詳細

addScopes

public TokenRequestContext addScopes(String[] scopes)

要求スコープに 1 つ以上のスコープを追加します。

Parameters:

scopes - 追加する 1 つ以上のスコープ

Returns:

TokenRequestContext 自体

getClaims

public String getClaims()

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

Returns:

トークンに含める追加の要求。

getScopes

public List getScopes()

トークンに必要なスコープを取得します。

Returns:

トークンに必要なスコープ

getTenantId

public String getTenantId()

認証要求に使用するテナント ID を取得します。

Returns:

構成されたテナント ID。

isCaeEnabled

public boolean isCaeEnabled()

要求されたトークンに対して継続的アクセス評価 (CAE) が有効になっているかどうかを示す状態を取得します。

Returns:

CAE 認証を使用するかどうかを示すフラグ。

setCaeEnabled

public TokenRequestContext setCaeEnabled(boolean enableCae)

要求されたトークンに対して継続的アクセス評価 (CAE) を有効にするかどうかを示します。

リソース API によって CAE が実装されていて、CAE を処理できることがご利用のアプリケーションで宣言されている場合、アプリは、そのリソースに対する CAE トークンを受信します。 このため、CAE に対応する準備がアプリでできていることを宣言する場合、アプリケーションは、Microsoft Identity アクセス トークンを受け入れるすべてのリソース API の CAE 要求チャレンジを処理する必要があります。 これらの API 呼び出し内で CAE 応答を処理しない場合、返された有効期間内にまだあるが CAE のために取り消されているトークンにより、アプリで API 呼び出しを再試行するループが発生する可能性があります。

Parameters:

enableCae - 要求されたトークンに対して継続的アクセス評価 (CAE) を有効にするかどうかを示すフラグ。

Returns:

更新された TokenRequestContext。

setClaims

public TokenRequestContext setClaims(String claims)

トークンに含める追加の要求を設定します。

Parameters:

claims - トークンに含める追加の要求。

Returns:

更新された TokenRequestContext 自体

setScopes

public TokenRequestContext setScopes(List scopes)

トークンに必要なスコープを設定します。

Parameters:

scopes - トークンに必要なスコープ

Returns:

TokenRequestContext 自体

setTenantId

public TokenRequestContext setTenantId(String tenantId)

認証要求に使用するテナント ID を設定します。

Parameters:

tenantId - トークンを要求するときに使用するテナント。

Returns:

更新された TokenRequestContext 自体

適用対象