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 门户中注册的重定向 URI,在 OAuth2.0 授权代码流的第一步中使用。

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 门户中注册的重定向 URI,在 OAuth2.0 授权代码流的第一步中使用。 有关详细信息,请参阅 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()

适用于