AuthorizationRequestUrlParameters.Builder 类

包:
com.microsoft.aad.msal4j
Maven 项目:
com.microsoft.azure:msal4j:1.19.1
  • java.lang.Object
    • com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder

public static class AuthorizationRequestUrlParameters.Builder

构造函数摘要

构造函数 说明
Builder()

方法摘要

修饰符和类型 方法和描述
AuthorizationRequestUrlParameters build()
Builder claims(ClaimsRequest val)

通过 OIDC 声明请求参数请求的声明，允许对标准和自定义声明的请求
Builder claimsChallenge(String val)

如果Azure AD 租户管理员启用了条件访问策略，并且尚未满足该策略，MsalServiceException则包含需要同意的声明。
Builder codeChallenge(String val)

用于通过代码Exchange（PKCE）的密钥证明来保护授权代码授予。
Builder codeChallengeMethod(String val)

用于对代码质询参数的代码验证程序进行编码的方法。
Builder correlationId(String val)

用于关联遥测请求的标识符。
Builder domainHint(String val)

提供有关用户应用于登录的租户或域的提示。
Builder extraQueryParameters(Map<String,String> val)

除了已提供的参数列表外，还可以向请求添加的查询参数。
Builder extraScopesToConsent(Set<String> val)

除了应用程序请求访问的范围之外，还可以请求最终用户提前同意的范围。
Builder instanceAware(boolean val)

如果设置为 true，授权结果将包含用户主云的颁发机构，并且此颁发机构将用于令牌请求，而不是应用程序中设置的颁发机构。
Builder loginHint(String val)

如果提前知道用户名/电子邮件地址，可用于预填充用户的登录页的用户名/电子邮件地址字段。
Builder nonce(String val)

同时随令牌响应返回的请求中所包含的值。
Builder prompt(Prompt val)

表示需要的用户交互类型。
Builder redirectUri(String val)

应用程序可以接收身份验证响应的重定向 URI。
Builder responseMode(ResponseMode val)

指定应用于将身份验证结果发送到应用的方法。
Builder scopes(Set<String> val)

应用程序请求访问的范围，用户将同意。
Builder state(String val)

同时随令牌响应返回的请求中所包含的值。

方法继承自 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 Builder()

方法详细信息

build

public AuthorizationRequestUrlParameters build()

claims

public AuthorizationRequestUrlParameters.Builder claims(ClaimsRequest val)

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

参数:

val

claimsChallenge

public AuthorizationRequestUrlParameters.Builder claimsChallenge(String val)

如果Azure AD 租户管理员启用了条件访问策略，并且尚未满足该策略，MsalServiceException则包含需要同意的声明。

参数:

val

codeChallenge

public AuthorizationRequestUrlParameters.Builder codeChallenge(String val)

用于通过代码Exchange（PKCE）的密钥证明来保护授权代码授予。 如果包含 codeChallenge，则为必需。 有关详细信息，请参阅 PKCE RCF： https://tools.ietf.org/html/rfc7636

参数:

val

codeChallengeMethod

public AuthorizationRequestUrlParameters.Builder codeChallengeMethod(String val)

用于对代码质询参数的代码验证程序进行编码的方法。 可以是普通或 S256 之一。 如果排除，则假定代码质询为纯文本。 有关详细信息，请参阅 PKCE RCF： https://tools.ietf.org/html/rfc7636

参数:

val

correlationId

public AuthorizationRequestUrlParameters.Builder correlationId(String val)

用于关联遥测请求的标识符。 通常为 GUID。

参数:

val

domainHint

public AuthorizationRequestUrlParameters.Builder domainHint(String val)

提供有关用户应用于登录的租户或域的提示。 域提示的值是租户的已注册域。

参数:

val

extraQueryParameters

public AuthorizationRequestUrlParameters.Builder extraQueryParameters(Map<String,String> val)

除了已提供的参数列表外，还可以向请求添加的查询参数。

参数:

val

extraScopesToConsent

public AuthorizationRequestUrlParameters.Builder extraScopesToConsent(Set<String> val)

除了应用程序请求访问的范围之外，还可以请求最终用户提前同意的范围。

参数:

val

instanceAware

public AuthorizationRequestUrlParameters.Builder instanceAware(boolean val)

如果设置为 true，授权结果将包含用户主云的颁发机构，并且此颁发机构将用于令牌请求，而不是应用程序中设置的颁发机构。

参数:

val

loginHint

public AuthorizationRequestUrlParameters.Builder loginHint(String val)

如果提前知道用户名/电子邮件地址，可用于预填充用户的登录页的用户名/电子邮件地址字段。 应用通常在重新身份验证期间使用此参数，使用 preferred_username 声明从以前的登录中提取用户名。

参数:

val

nonce

public AuthorizationRequestUrlParameters.Builder nonce(String val)

同时随令牌响应返回的请求中所包含的值。 随机生成的唯一值通常用于防止跨站点请求伪造攻击。

参数:

val

prompt

public AuthorizationRequestUrlParameters.Builder prompt(Prompt val)

表示需要的用户交互类型。 可能的值为 Prompt

参数:

val

redirectUri

public AuthorizationRequestUrlParameters.Builder redirectUri(String val)

应用程序可以接收身份验证响应的重定向 URI。 它必须与在 Azure 门户中注册的其中一个重定向 URI 完全匹配。

参数:

val

responseMode

public AuthorizationRequestUrlParameters.Builder responseMode(ResponseMode val)

指定应用于将身份验证结果发送到应用的方法。

参数:

val

scopes

public AuthorizationRequestUrlParameters.Builder scopes(Set<String> val)

应用程序请求访问的范围，用户将同意。

参数:

val

state

public AuthorizationRequestUrlParameters.Builder state(String val)

同时随令牌响应返回的请求中所包含的值。 随机生成的唯一值通常用于防止跨站点请求伪造攻击。 该状态还用于在身份验证请求发生之前对应用中用户状态的信息进行编码。

参数:

val

适用于