你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 将取决于所使用的身份验证机制。 例如，如果使用 Azure 标识进行 AAD 身份验证，则会将 TokenRequestContext 实例传递到实现的 TokenCredential getToken 方法。
3. 身份验证客户端或机制将处理令牌请求，并返回可用于对 Azure 服务的请求进行身份验证和授权的访问令牌。

构造函数摘要

构造函数	说明
TokenRequestContext()	创建令牌请求实例。

方法摘要

修饰符和类型	方法和描述
TokenRequestContext	addScopes(String[] scopes) 将一个或多个范围添加到请求范围。
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)

将一个或多个范围添加到请求范围。

Parameters:

scopes - 要添加的一个或多个范围

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 标识访问令牌的资源 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 本身