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

InteractiveBrowserCredential class

允许使用交互式登录流在 Web 浏览器中Microsoft Entra ID 的身份验证。

构造函数

InteractiveBrowserCredential(InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

使用所需的详细信息创建 InteractiveBrowserCredential 的实例。

此凭据使用 授权代码流。 在 Node.js,它会在侦听来自身份验证服务的重定向响应时打开浏览器窗口。 在浏览器中,它通过弹出窗口进行身份验证。 loginStyle 可选参数可以设置为 redirect 进行身份验证,方法是将用户重定向到 Azure 安全登录页,然后将用户重定向回身份验证启动的 Web 应用程序。

对于 Node.js,如果提供了 clientId,则需要将Microsoft Entra 应用程序配置为具有“移动和桌面应用程序”重定向终结点。 按照我们的指南 为调用 Web API 的桌面应用设置重定向 URI

方法

authenticate(string | string[], GetTokenOptions)

使用 Microsoft Entra ID 进行身份验证,如果成功,则返回访问令牌。 如果身份验证失败,则会引发 CredentialUnavailableError,其中包含失败的详细信息。

如果无法以无提示方式检索令牌,此方法将始终为用户生成质询。

在 Node.js,默认情况下,此凭据 代码交换(PKCE) 的证明密钥。 PKCE 是一项安全功能,可缓解身份验证代码拦截攻击。

getToken(string | string[], GetTokenOptions)

使用 Microsoft Entra ID 进行身份验证,如果成功,则返回访问令牌。 如果身份验证失败,则会引发 CredentialUnavailableError,其中包含失败的详细信息。

如果用户提供了 disableAutomaticAuthentication选项,则一旦无法以无提示方式检索令牌,此方法将不会尝试请求用户交互以检索令牌。

构造函数详细信息

InteractiveBrowserCredential(InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

使用所需的详细信息创建 InteractiveBrowserCredential 的实例。

此凭据使用 授权代码流。 在 Node.js,它会在侦听来自身份验证服务的重定向响应时打开浏览器窗口。 在浏览器中,它通过弹出窗口进行身份验证。 loginStyle 可选参数可以设置为 redirect 进行身份验证,方法是将用户重定向到 Azure 安全登录页,然后将用户重定向回身份验证启动的 Web 应用程序。

对于 Node.js,如果提供了 clientId,则需要将Microsoft Entra 应用程序配置为具有“移动和桌面应用程序”重定向终结点。 按照我们的指南 为调用 Web API 的桌面应用设置重定向 URI

new InteractiveBrowserCredential(options: InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

参数

options

InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions

用于配置发出身份验证请求的客户端的选项。

方法详细信息

authenticate(string | string[], GetTokenOptions)

使用 Microsoft Entra ID 进行身份验证,如果成功,则返回访问令牌。 如果身份验证失败,则会引发 CredentialUnavailableError,其中包含失败的详细信息。

如果无法以无提示方式检索令牌,此方法将始终为用户生成质询。

在 Node.js,默认情况下,此凭据 代码交换(PKCE) 的证明密钥。 PKCE 是一项安全功能,可缓解身份验证代码拦截攻击。

function authenticate(scopes: string | string[], options?: GetTokenOptions): Promise<undefined | AuthenticationRecord>

参数

scopes

string | string[]

令牌有权访问的范围列表。

options
GetTokenOptions

用于配置此 TokenCredential 实现可能发出的任何请求的选项。

返回

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

使用 Microsoft Entra ID 进行身份验证,如果成功,则返回访问令牌。 如果身份验证失败,则会引发 CredentialUnavailableError,其中包含失败的详细信息。

如果用户提供了 disableAutomaticAuthentication选项,则一旦无法以无提示方式检索令牌,此方法将不会尝试请求用户交互以检索令牌。

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

参数

scopes

string | string[]

令牌有权访问的范围列表。

options
GetTokenOptions

用于配置此 TokenCredential 实现可能发出的任何请求的选项。

返回

Promise<AccessToken>