ClientCredentialParameters 类

  • java.lang.Object
    • com.microsoft.aad.msal4j.ClientCredentialParameters

实现

com.microsoft.aad.msal4j.IAcquireTokenParameters

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

包含客户端凭据流的参数的对象。 可用作参数 acquireToken(ClientCredentialParameters parameters)

方法摘要

修饰符和类型 方法和描述
static ClientCredentialParametersBuilder builder(Set<String> scopes)

Builder for ClientCredentialParameters

ClaimsRequest claims()

获取将使用身份验证请求发送的声明请求参数。

java.lang.String clientClaims()

通过 ClientCredentialParametersBuilder#claimsFromClient(String). 设置的客户端发起的声明。

IClientCredential clientCredential()
java.lang.String computeExtCacheKeyHash()

从所有缓存密钥组件计算扩展缓存密钥哈希。

java.util.Map<java.lang.String,java.lang.String> extraHttpHeaders()

获取要包含在令牌请求中的其他 HTTP 标头。

java.util.Map<java.lang.String,java.lang.String> extraQueryParameters()

已放弃

不建议用于生产方案。 它将在将来的版本中删除,并且行为可能被新 API 替换。

获取要包含在令牌请求中的其他查询参数。

java.lang.String fmiPath()

获取代理标识方案的 FMI(联合托管标识)路径。

java.util.Set<java.lang.String> scopes()

获取为访问令牌请求的范围(权限)集。

java.lang.Boolean skipCache()
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 ClientCredentialParameters.ClientCredentialParametersBuilder builder(Set<String> scopes)

Builder for ClientCredentialParameters

参数:

scopes - scopes 应用程序正在请求访问

返回:

可用于构造 ClientCredentialParameters 的生成器

claims

public ClaimsRequest claims()

获取将使用身份验证请求发送的声明请求参数。

声明请求参数可用于请求令牌中返回的特定声明、请求 MFA 身份验证或控制令牌颁发的其他方面。

clientClaims

public String clientClaims()

通过 ClientCredentialParametersBuilder#claimsFromClient(String). 设置的客户端发起的声明。 作为 OAuth claims 参数转发到令牌终结点,并用作扩展缓存密钥的一部分,以便单独缓存不同的声明值。

clientCredential

public IClientCredential clientCredential()

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

从所有缓存密钥组件计算扩展缓存密钥哈希。 如果没有组件,则返回空字符串。

由于 ClientCredentialParameters 在构造后是不可变的,因此结果将被备忘录化。 由缓存写入(TokenCache)和缓存读取(无提示查找)使用。

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

获取要包含在令牌请求中的其他 HTTP 标头。

这些标头将添加到发送到令牌终结点的 HTTP 请求中。 这对于需要自定义标头的代理或诊断目的的方案非常有用。

extraQueryParameters


public Map<String,String> extraQueryParameters()

已放弃

不建议用于生产方案。 它将在将来的版本中删除,并且行为可能被新 API 替换。

获取要包含在令牌请求中的其他查询参数。

这些参数将添加到对授权和令牌终结点的请求中的查询字符串。 这对于需要库中未显式支持的自定义参数的方案非常有用。

fmiPath

public String fmiPath()

获取代理标识方案的 FMI(联合托管标识)路径。 设置后, fmi_path 在客户端凭据令牌请求中作为正文参数发送,该请求将生成的令牌限定为特定的代理标识。

返回:

FMI 路径,如果未设置,则为 null

scopes

public Set<String> scopes()

获取为访问令牌请求的范围(权限)集。

范围表示应用程序请求访问的权限。

skipCache

public Boolean skipCache()

tenant

public String tenant()

获取令牌请求的租户标识符。

指定后,此值将替代应用程序颁发机构 URL 中指定的租户。 它可以是租户 ID(GUID)、域名或特殊值之一,例如“common”或“organizations”。

适用于