InteractiveRequestParameters 类

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

实现

com.microsoft.aad.msal4j.IAcquireTokenParameters

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

包含交互式请求的参数的对象。 可用作参数。acquireToken(InteractiveRequestParameters parameters)

如需了解详情，请访问 https://aka.ms/msal4j-interactive-request。

方法摘要

修饰符和类型 方法和描述
static InteractiveRequestParametersBuilder builder(URI redirectUri)
ClaimsRequest claims()

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

提供有关用户应用于登录的租户或域的提示。
java.util.Map<java.lang.String,java.lang.String> extraHttpHeaders()

向令牌请求添加其他标头
java.util.Map<java.lang.String,java.lang.String> extraQueryParameters()

将其他查询参数添加到令牌请求
int httpPollingTimeoutInSeconds()

库将等待身份验证结果的时间（以秒为单位）。
boolean instanceAware()

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

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

指示所需的用户交互类型。
PopParameters proofOfPossession()
@lombok.NonNull java.net.URI redirectUri()

重定向 URI，MSAL 将侦听 Azure AD 返回的授权代码。
java.util.Set<java.lang.String> scopes()

应用程序请求访问权限的范围，用户将同意。
SystemBrowserOptions systemBrowserOptions()

公共客户端应用程序要使用的集SystemBrowserOptions
java.lang.String tenant()

替代此请求的颁发机构 URL 中的租户值
long windowHandle()

父窗口句柄，用于打开具有正确父级的 UI 元素（对于浏览器方案和Windows控制台应用程序），对于Windows控制台应用程序，MSAL Java在未设置此参数的情况下尝试发现控制台的窗口句柄。对于 MSAL Java负责打开 UI 元素（例如使用 MSALRuntime 时），此参数是必需的，如果未设置，将引发异常

方法继承自 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 InteractiveRequestParameters.InteractiveRequestParametersBuilder builder(URI redirectUri)

参数:

redirectUri

claims

public ClaimsRequest claims()

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

claimsChallenge

public String claimsChallenge()

domainHint

public String domainHint()

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

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

向令牌请求添加其他标头

extraQueryParameters

public Map<String,String> extraQueryParameters()

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

httpPollingTimeoutInSeconds

public int httpPollingTimeoutInSeconds()

库将等待身份验证结果的时间（以秒为单位）。 120 秒是默认超时，除非在此处用一些其他正整数重写（如果此超时设置为 0 或更少）将被忽略，并且库将改用 1 秒超时

instanceAware

public boolean instanceAware()

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

loginHint

public String loginHint()

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

prompt

public Prompt prompt()

指示所需的用户交互类型。

proofOfPossession

public PopParameters proofOfPossession()

redirectUri

public @NonNull URI redirectUri()

重定向 URI，MSAL 将侦听 Azure AD 返回的授权代码。 应该是具有指定端口的环回地址（例如， http://localhost:3671). 如果未指定端口，MSAL 将找到一个打开的端口。 有关详细信息，请参阅 https://aka.ms/msal4j-interactive-request。

scopes

public Set<String> scopes()

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

systemBrowserOptions

public SystemBrowserOptions systemBrowserOptions()

PublicClientApplication 要使用的集SystemBrowserOptions

tenant

public String tenant()

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

windowHandle

public long windowHandle()

父窗口句柄，用于打开具有正确父级的 UI 元素（对于浏览器方案和Windows控制台应用程序），对于Windows控制台应用程序，MSAL Java在未设置此参数的情况下尝试发现控制台的窗口句柄。对于 MSAL Java负责打开 UI 元素（例如使用 MSALRuntime 时），此参数是必需的，如果未设置，将引发异常

适用于