ClientCredentialParameters.ClientCredentialParametersBuilder 类

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

public static class ClientCredentialParameters.ClientCredentialParametersBuilder

方法摘要

修饰符和类型 方法和描述
ClientCredentialParameters build()
ClientCredentialParametersBuilder claims(ClaimsRequest claims)

通过 OIDC 声明请求参数请求的声明,允许对标准和自定义声明的请求

ClientCredentialParametersBuilder claimsFromClient(String claimsJson)

指定作为 OAuth claims 请求参数转发到令牌终结点的客户端发起声明(原始 JSON 对象字符串)。

ClientCredentialParametersBuilder clientCredential(IClientCredential clientCredential)

替代此请求的客户端凭据

ClientCredentialParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

向令牌请求添加其他标头

ClientCredentialParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

已放弃

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

将其他查询参数添加到令牌请求

ClientCredentialParametersBuilder fmiPath(String fmiPath)

为代理标识方案设置 FMI(联合托管标识)路径。

ClientCredentialParametersBuilder scopes(Set<String> scopes)

范围应用程序正在请求访问。

ClientCredentialParametersBuilder skipCache(Boolean skipCache)

指示请求是否应跳过查看令牌缓存。

ClientCredentialParametersBuilder 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

方法详细信息

build

public ClientCredentialParameters build()

claims

public ClientCredentialParameters.ClientCredentialParametersBuilder claims(ClaimsRequest claims)

通过 OIDC 声明请求参数请求的声明,允许对标准和自定义声明的请求

参数:

claims

claimsFromClient

public ClientCredentialParameters.ClientCredentialParametersBuilder claimsFromClient(String claimsJson)

指定作为 OAuth claims 请求参数转发到令牌终结点的客户端发起声明(原始 JSON 对象字符串)。 与 claims(ClaimsRequest claims) (绕过缓存的服务器颁发的声明质询)不同,使用客户端声明获取的令牌将缓存,缓存项将键式处理声明值,因此不同的声明值会生成单独的缓存条目。 使用稳定的非动态值以避免缓存碎片。 针对给定令牌的每个请求发送相同的值;因为原始值是缓存键的一部分,因此更改或省略它会将请求路由到其他缓存分区。 忽略空值;无效的 JSON 对象引发 MsalClientException。

参数:

claimsJson - 包含客户端声明的有效 JSON 对象字符串

返回:

可用于构造 ClientCredentialParameters 的生成器

clientCredential

public ClientCredentialParameters.ClientCredentialParametersBuilder clientCredential(IClientCredential clientCredential)

替代此请求的客户端凭据

参数:

clientCredential

extraHttpHeaders

public ClientCredentialParameters.ClientCredentialParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

向令牌请求添加其他标头

参数:

extraHttpHeaders

extraQueryParameters


public ClientCredentialParameters.ClientCredentialParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

已放弃

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

将其他查询参数添加到令牌请求

参数:

extraQueryParameters

fmiPath

public ClientCredentialParameters.ClientCredentialParametersBuilder fmiPath(String fmiPath)

为代理标识方案设置 FMI(联合托管标识)路径。 设置后,fmi_path在客户端凭据令牌请求中以正文参数的形式发送,该请求告知Entra ID将生成的令牌限定为特定的代理标识。 令牌还使用扩展缓存密钥进行缓存,以防止不同代理标识的令牌之间发生冲突。

参数:

fmiPath - FMI 路径值(通常是代理应用程序 ID)

返回:

可用于构造 ClientCredentialParameters 的生成器

scopes

public ClientCredentialParameters.ClientCredentialParametersBuilder scopes(Set<String> scopes)

范围应用程序正在请求访问。

不能为 null。

参数:

scopes

skipCache

public ClientCredentialParameters.ClientCredentialParametersBuilder skipCache(Boolean skipCache)

指示请求是否应跳过查看令牌缓存。 默认值设置为 false。

参数:

skipCache

tenant

public ClientCredentialParameters.ClientCredentialParametersBuilder tenant(String tenant)

替代此请求的颁发机构 URL 中的租户值

参数:

tenant

toString

public String toString()

替代:

ClientCredentialParameters.ClientCredentialParametersBuilder.toString()

适用于