你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

InteractiveBrowserCredentialBuilder 类

public class InteractiveBrowserCredentialBuilder
extends AadCredentialBuilderBase<InteractiveBrowserCredentialBuilder>

用于实例化 的 InteractiveBrowserCredentialFluent 凭据生成器。

交互式浏览器身份验证是 Azure Active Directory (Azure AD) 提供的一种身份验证流,使用户能够使用 Web 浏览器登录到应用程序和服务。 此身份验证方法通常用于 Web 应用程序,其中用户直接在网页中输入其凭据。 使用交互式浏览器身份验证时,用户导航到 Web 应用程序,并提示输入其用户名和密码凭据。 然后,应用程序将用户重定向到 Azure AD 登录页,系统会提示他们再次输入凭据。 用户成功进行身份验证后,Azure AD 会颁发一个安全令牌,应用程序可以使用该令牌授权用户访问其资源。 以 InteractiveBrowserCredential 交互方式对用户进行身份验证,并使用默认系统浏览器获取令牌,并通过允许用户使用自己的凭据对应用程序进行身份验证来提供流畅的身份验证体验。 进行身份验证后,oauth2 流会通过回复 URL 通知身份验证代码的凭据。 有关详细信息,请参阅 概念知识和配置详细信息

示例:构造 InteractiveBrowserCredential

下面的代码示例演示如何创建 InteractiveBrowserCredential,使用 InteractiveBrowserCredentialBuilder 对其进行配置。 默认情况下,凭据以 localhost 重定向 URL 为目标,以替代该行为 redirectUrl(String redirectUrl) ,可以选择指定 。 创建此凭据后,它可能会作为“credential”参数传递到许多 Azure SDK for Java 客户端生成器的生成器中。

TokenCredential interactiveBrowserCredential = new InteractiveBrowserCredentialBuilder()
     .redirectUrl("http://localhost:8765")
     .build();

构造函数摘要

构造函数 说明
InteractiveBrowserCredentialBuilder()

方法摘要

修饰符和类型 方法和描述
InteractiveBrowserCredentialBuilder additionallyAllowedTenants(String[] additionallyAllowedTenants)

对于多租户应用程序, 指定凭据可能为其获取令牌的其他租户。

InteractiveBrowserCredentialBuilder additionallyAllowedTenants(List<String> additionallyAllowedTenants)

对于多租户应用程序, 指定凭据可能为其获取令牌的其他租户。

InteractiveBrowserCredentialBuilder authenticationRecord(AuthenticationRecord authenticationRecord)

AuthenticationRecord设置从以前的身份验证中捕获的 。

InteractiveBrowserCredentialBuilder browserCustomizationOptions(BrowserCustomizationOptions browserCustomizationOptions)

配置用于自定义浏览器以执行交互式身份验证的选项。

InteractiveBrowserCredential build()

使用当前配置创建新的 InteractiveBrowserCredential

InteractiveBrowserCredentialBuilder disableAutomaticAuthentication()

禁用自动身份验证并阻止 InteractiveBrowserCredential 自动提示用户。

InteractiveBrowserCredentialBuilder loginHint(String loginHint)

设置用户名建议以预先填充登录页的用户名/电子邮件地址字段。

InteractiveBrowserCredentialBuilder port(int port)

已放弃

改为通过 配置重定向 URL http://localhost:{port}redirectUrl(String redirectUrl)

设置本地 HTTP 服务器的端口,必须为其 http://localhost:{port} 注册为应用程序上的有效回复 URL。

InteractiveBrowserCredentialBuilder redirectUrl(String redirectUrl)

设置重定向 URL,STS 将使用安全代码回调应用程序。

InteractiveBrowserCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)

配置永久性共享令牌缓存选项,并启用默认禁用的永久性令牌缓存。

方法继承自 AadCredentialBuilderBase

方法继承自 CredentialBuilderBase

方法继承自 java.lang.Object

构造函数详细信息

InteractiveBrowserCredentialBuilder

public InteractiveBrowserCredentialBuilder()

方法详细信息

additionallyAllowedTenants

public InteractiveBrowserCredentialBuilder additionallyAllowedTenants(String[] additionallyAllowedTenants)

对于多租户应用程序, 指定凭据可能为其获取令牌的其他租户。 添加通配符值“*”以允许凭据获取安装应用程序的任何租户的令牌。 如果未为 TenantId 指定值,此选项将不起作用,并且凭据将获取任何请求的租户的令牌。

Overrides:

InteractiveBrowserCredentialBuilder.additionallyAllowedTenants(String[] additionallyAllowedTenants)

Parameters:

additionallyAllowedTenants - 其他允许的租户。

Returns:

此生成器的更新实例,其中配置了其他租户。

additionallyAllowedTenants

public InteractiveBrowserCredentialBuilder additionallyAllowedTenants(List additionallyAllowedTenants)

对于多租户应用程序, 指定凭据可能为其获取令牌的其他租户。 添加通配符值“*”以允许凭据获取安装应用程序的任何租户的令牌。 如果未为 TenantId 指定值,此选项将不起作用,并且凭据将获取任何请求的租户的令牌。

Overrides:

InteractiveBrowserCredentialBuilder.additionallyAllowedTenants(List<String> additionallyAllowedTenants)

Parameters:

additionallyAllowedTenants - 其他允许的租户。

Returns:

此生成器的更新实例,其中配置了其他租户。

authenticationRecord

public InteractiveBrowserCredentialBuilder authenticationRecord(AuthenticationRecord authenticationRecord)

AuthenticationRecord设置从以前的身份验证中捕获的 。

Parameters:

authenticationRecord - 要配置的身份验证记录。

Returns:

此生成器的更新实例,其中包含配置的身份验证记录。

browserCustomizationOptions

public InteractiveBrowserCredentialBuilder browserCustomizationOptions(BrowserCustomizationOptions browserCustomizationOptions)

配置用于自定义浏览器以执行交互式身份验证的选项。

Parameters:

browserCustomizationOptions - 浏览器自定义选项

Returns:

此生成器的更新实例,其中配置了浏览器自定义选项。

build

public InteractiveBrowserCredential build()

使用当前配置创建新的 InteractiveBrowserCredential

Returns:

具有 InteractiveBrowserCredential 当前配置的 。

disableAutomaticAuthentication

public InteractiveBrowserCredentialBuilder disableAutomaticAuthentication()

禁用自动身份验证并阻止 InteractiveBrowserCredential 自动提示用户。 如果禁用了 AuthenticationRequiredException 自动身份验证,则在需要用户交互的情况下,将从 中引发 getToken(TokenRequestContext request) 。 应用程序负责处理此异常,并调用 authenticate()authenticate(TokenRequestContext request) 以交互方式对用户进行身份验证。

Returns:

已禁用自动身份验证的此生成器的更新实例。

loginHint

public InteractiveBrowserCredentialBuilder loginHint(String loginHint)

设置用户名建议以预先填充登录页的用户名/电子邮件地址字段。 用户仍可能使用不同的用户名登录。

Parameters:

loginHint - 用于预填充登录页的用户名/电子邮件地址字段的用户名建议。

Returns:

此生成器的更新实例,其中配置了登录提示。

port

@Deprecated
public InteractiveBrowserCredentialBuilder port(int port)

已放弃

改为通过 配置重定向 URL http://localhost:{port}redirectUrl(String redirectUrl)

设置本地 HTTP 服务器的端口,必须为其 http://localhost:{port} 注册为应用程序上的有效回复 URL。

Parameters:

port - 凭据将侦听浏览器身份验证结果的端口

Returns:

InteractiveBrowserCredentialBuilder 本身

redirectUrl

public InteractiveBrowserCredentialBuilder redirectUrl(String redirectUrl)

设置重定向 URL,STS 将使用安全代码回调应用程序。 如果通过 InteractiveBrowserCredentialBuilder#clientId(String) 指定自定义客户端 ID,并且必须与应用程序注册期间指定的重定向 URL 匹配,则它是必需的。

Parameters:

redirectUrl - 用于侦听和接收安全代码的重定向 URL。

Returns:

此生成器的更新实例,其中包含配置的重定向 URL。

tokenCachePersistenceOptions

public InteractiveBrowserCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)

配置永久性共享令牌缓存选项,并启用默认禁用的永久性令牌缓存。 如果已配置,凭据会将令牌存储在保留到计算机的缓存中,该缓存对当前用户进行保护,可由其他凭据和进程共享。

Parameters:

tokenCachePersistenceOptions - 令牌缓存配置选项

Returns:

此生成器的更新实例,其中配置了令牌缓存选项。

适用于