InteractiveBrowserCredential class

包:

@azure/identity

通过交互式登录流程，在网页浏览器内实现对 Microsoft Entra ID 的认证。

构造函数

InteractiveBrowserCredential(InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

使用所需的详细信息创建 InteractiveBrowserCredential 的实例。 此凭据使用 授权代码流。 在 Node.js，它会在侦听来自身份验证服务的重定向响应时打开浏览器窗口。 在浏览器中，它通过弹出窗口进行身份验证。 可选参数 loginStyle 可设置为 redirect，通过重定向用户到Azure安全的登录页面来进行认证，然后该页面会将用户重定向回认证开始的网页应用。 对于 Node.js，如果提供了clientId，Microsoft Entra应用需要配置为“移动端和桌面应用”重定向端点。 按照我们的指南 为调用 Web API 的桌面应用设置重定向 URI。

方法

authenticate(string | string[], GetTokenOptions)	使用 Microsoft Entra ID 认证，成功时返回访问令牌。 如果身份验证失败，则会引发 CredentialUnavailableError，其中包含失败的详细信息。 如果无法以无提示方式检索令牌，此方法将始终为用户生成质询。 在 Node.js，该凭证默认启用了代码Exchange验证密钥 （PKCE）。 PKCE 是一项安全功能，可缓解身份验证代码拦截攻击。
getToken(string | string[], GetTokenOptions)	使用 Microsoft Entra ID 认证，成功时返回访问令牌。 如果身份验证失败，则会引发 CredentialUnavailableError，其中包含失败的详细信息。 如果用户提供了 disableAutomaticAuthentication选项，则一旦无法以无提示方式检索令牌，此方法将不会尝试请求用户交互以检索令牌。

构造函数详细信息

InteractiveBrowserCredential(InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

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

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

对于 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，该凭证默认启用了代码Exchange验证密钥 （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>