@azure/msal-browser package

MSAL.js 库引发的常规错误类。

这是一个帮助程序类，用于分析支持的 HTTP 响应身份验证标头，以提取和返回可在基本授权流外部使用的标头质询值。

MSAL.js SPA 库引发的浏览器库错误类

MSAL.js SPA 库引发的浏览器库错误类

在浏览器中运行的客户端代码中出现错误时引发的错误。

配置 MSAL.js 库时引发的错误。

需要用户交互时引发的错误。

有助于将消息记录到特定位置的类。

PublicClientApplication 类是库公开的对象，用于在单页应用程序中执行身份验证和授权函数，以便获取 JWT 令牌，如 OAuth 2.0 授权代码流和 PKCE 规范中所述。

PublicClientNext 是在下一个主要版本的 MSAL.js中提前了解 PublicClientApplication 的计划实现。 它包含对基于其正在运行的运行时环境的多个 API 实现的支持。

这些更改的目标是在不同的操作上下文（嵌套应用身份验证、平台代理、普通旧浏览器等）之间提供完全的行为分离，同时仍为开发人员提供一致的 API 图面。

对于任何 prod/real-world 方案，请使用 PublicClientApplication。 注意：PublicClientNext 是实验性的，不受以下 semver 影响的重大更改

当服务器代码出错（例如不可用）时引发的错误。

可以对 URL 字符串执行各种转换的 URL 对象类。

身份验证流中操作重新调用状态的基类。

身份验证流的状态的基类。

身份验证方法质询请求期间发生的错误。

对注册的身份验证方法具有挑战性的结果。 使用基本状态类型来避免循环依赖项。

指示身份验证方法注册流已成功完成的状态。

指示身份验证方法注册流失败的状态。

指示需要身份验证方法注册的状态。

身份验证方法质询提交过程中发生的错误。

提交身份验证方法注册质询的结果。

指示质询身份验证方法需要验证的状态。

自定义身份验证 API 错误。

获取帐户错误的错误类。

用于获取当前帐户访问令牌错误的错误类。

指示需要 MFA 并等待用户操作的状态。 此状态允许开发人员在将代码发送到用户的电子邮件之前暂停执行。

指示 MFA 流已成功完成的状态。

指示 MFA 流失败的状态。

MFA 质询请求期间发生的错误。

请求 MFA 质询的结果。 使用基本状态类型来避免循环依赖项。

MFA 质询提交期间发生的错误。

提交 MFA 质询的结果。

指示需要 MFA 验证的状态。 已发送质询，用户需要提供代码。

身份验证流中操作重新调用状态的基类。

表示指示密码重置操作成功完成的状态。

已失败的重置密码操作的状态。

身份验证流中操作重新调用状态的基类。

身份验证流中操作重新调用状态的基类。

身份验证流中操作重新调用状态的基类。

表示登录操作的已完成状态。 此状态指示登录过程已成功完成。

身份验证流中操作重新调用状态的基类。

表示已失败的登录操作的状态。

身份验证流中操作重新调用状态的基类。

身份验证流中操作重新调用状态的基类。

注销错误的错误类。

身份验证流中操作重新调用状态的基类。

身份验证流中操作重新调用状态的基类。

表示注册操作的状态，该操作已成功完成。

表示注册操作已失败的状态。

身份验证流中操作重新调用状态的基类。

身份验证流中操作重新调用状态的基类。

用于发送后端请求的客户端网络接口。

要注册的身份验证方法的详细信息。

具有以下签名的 Account 对象：

• homeAccountId - 此帐户对象的主页帐户标识符
• 环境 - 颁发颁发者域所表示的令牌的实体（例如 login.microsoftonline.com）
• tenantId - 此帐户所属的完整租户或组织 ID
• username - preferred_username表示此帐户的id_token声明
• localAccountId - 此帐户对象的本地特定于租户的帐户标识器，通常用于旧用例
• name - 帐户的全名，包括给定名称和姓氏
• idToken - 原始 ID 令牌
• idTokenClaims - 对象包含来自 ID 令牌的声明
• nativeAccountId - 用户的本机帐户 ID
• tenantProfiles - 映射帐户在浏览器中通过身份验证的每个租户的租户配置文件对象
• dataBoundary - 从 clientInfo 提取的数据边界

此类型已弃用，将在下一次主版本更新中删除

AzureCloudInstance 特定选项

• azureCloudInstance - 字符串枚举为 soverign 和公有云颁发机构提供短表示法
• tenant - 预配以提供租户信息

BrokerConnectionEstablished 事件的有效负载

使用此选项在 Configuration 对象中配置身份验证选项

遥测选项

使用此选项配置以下缓存配置选项：

ClearCacheRequest

• correlationId - 每个请求的唯一 GUID 集，用于跟踪用于遥测目的的请求端到端。
• account - 将注销的 Account 对象。 将清除绑定到此帐户的所有令牌。

此对象允许你配置 MSAL 功能的重要元素，并传递到 PublicClientApplication 的构造函数中

EndSessionPopupRequest

• account - 将注销的 Account 对象。 将清除绑定到此帐户的所有令牌。
• postLogoutRedirectUri - 在弹出窗口中的注销页面后导航到的 URI。 需要确保弹出窗口可以关闭。
• authority - 要向其发送注销请求的颁发机构。
• correlationId - 每个请求的唯一 GUID 集，用于跟踪用于遥测目的的请求端到端。
• idTokenHint - B2C 用于验证策略所需的注销的 ID 令牌
• mainWindowRedirectUri - 用于在注销完成后将主窗口导航到的 URI
• popupWindowAttributes - 可选弹出窗口属性。 可以设置具有高度和宽度的 popupSize，还可以设置顶部和左侧的 popupPosition。
• logoutHint - 一个字符串，指定要注销的帐户，以便在注销时跳过服务器帐户选取器
• popupWindowParent - 打开弹出窗口时用作父对象的可选窗口对象。 如果未指定，则使用全局 window 。

EndSessionRequest

• account - 将注销的 Account 对象。 将清除绑定到此帐户的所有令牌。
• postLogoutRedirectUri - 在注销页面后导航到的 URI。
• authority - 要向其发送注销请求的颁发机构。
• correlationId - 每个请求的唯一 GUID 集，用于跟踪用于遥测目的的请求端到端。
• idTokenHint - B2C 用于验证策略所需的注销的 ID 令牌
• onRedirectNavigate - 将传递 MSAL 将导航到的 URL 的回调。 在回调中返回 false 将停止导航。
• logoutHint - 一个字符串，指定要注销的帐户，以便在注销时跳过服务器帐户选取器

用于加载外部令牌以缓存的响应对象。

• token_type：指示标记类型值。 AZURE AD 支持的唯一类型是 Bearer。
• 范围：access_token有效的范围。
• expires_in：访问令牌的有效时间（以秒为单位）。
• id_token：JSON Web 令牌（JWT）。 应用可以解码此令牌的段，以请求有关登录用户的信息。
• refresh_token：OAuth 2.0 刷新令牌。 应用可以在当前访问令牌过期后使用此令牌获取其他访问令牌。
• access_token：请求的访问令牌。 应用可以使用此令牌对受保护的资源（如 Web API）进行身份验证。
• client_info：客户端信息对象

描述 MSAL 已知的 ID 令牌声明的类型。

InitializeApplicationRequest：用户传递的请求对象初始化应用程序

• correlationId - 每个请求的唯一 GUID 集，用于跟踪用于遥测目的的请求端到端。

传递给 navigateInternal 和 navigateExternal 函数的其他信息

网络请求 API 允许的选项。

库执行的性能度量，包括有关请求和应用程序的元数据。

PopupRequest：使用弹出窗口从服务器（授权代码授予流的第一回合）检索代码的请求对象。

• scopes - 应用程序请求访问的范围数组。
• authority - 应用程序从中获取令牌的颁发机构的 URL。
• correlationId - 每个请求的唯一 GUID 集，用于跟踪用于遥测目的的请求端到端。
• redirectUri - 应用程序可以接收身份验证响应的重定向 URI。 它必须与在 Azure 门户中注册的其中一个重定向 URI 完全匹配。
• extraScopesToConsent - 当用户需要事先同意时，其他资源的作用域。
• state - 在令牌响应中也返回的请求中包含的值。 随机生成的唯一值通常用于防止跨站点请求伪造攻击。 该状态还用于在身份验证请求发生之前对应用中用户状态的信息进行编码。
• prompt - 指示所需的用户交互类型。 login：将强制用户在该请求上输入其凭据，取消单一登录：将确保用户未显示任何交互式提示。 如果无法通过单一登录完成请求，终结点将返回interaction_required错误同意：用户登录后将触发 OAuth 同意对话框，要求用户向应用授予权限select_account：将中断单一登录=提供帐户选择体验，其中列出了会话中的所有帐户或任何记住的帐户，或者选择使用其他帐户创建的选项： 会将用户定向到帐户创建体验而不是登录体验no_session：在对用户进行身份验证时不会读取现有会话令牌。 用户成功进行身份验证后，EVO 不会为用户创建新会话。 仅供内部使用。
• loginHint - 如果提前知道用户名/电子邮件地址，可用于预填充用户的登录页的用户名/电子邮件地址字段。 应用通常在重新身份验证期间使用此参数，使用 login_hint 或preferred_username声明从以前的登录中提取用户名。
• sid - 会话 ID，会话的唯一标识符。 作为 ID 令牌的可选声明提供。
• domainHint - 提供有关用户应用于登录的租户或域的提示。 域提示的值是租户的已注册域。
• extraQueryParameters - 添加到 /authorize 调用的自定义查询参数的字符串到字符串映射
• tokenBodyParameters - 添加到 /token 调用的自定义令牌请求正文参数的字符串映射。 仅在续订访问令牌时使用。
• tokenQueryParameters - 添加到 /token 调用的自定义查询参数的字符串映射
• 声明 - 如果Azure AD 租户管理员启用了条件访问策略，并且策略尚未满足，则例外将包含需要同意的声明。
• nonce - ID 令牌中返回的请求中包含的值。 随机生成的唯一值通常用于缓解重播攻击。
• popupWindowAttributes - 可选弹出窗口属性。 可以设置具有高度和宽度的 popupSize，还可以设置顶部和左侧的 popupPosition。
• popupWindowParent - 打开弹出窗口时用作父对象的可选窗口对象。 如果未指定，则使用全局 window 。

用于设置弹出窗口维度和位置的弹出窗口配置

RedirectRequest：使用完整页面重定向从服务器（授权代码授予流的第一回合）检索代码的请求对象。

• scopes - 应用程序请求访问的范围数组。
• authority - 应用程序从中获取令牌的颁发机构的 URL。
• correlationId - 每个请求的唯一 GUID 集，用于跟踪用于遥测目的的请求端到端。
• redirectUri - 应用程序可以接收身份验证响应的重定向 URI。 它必须与在 Azure 门户中注册的其中一个重定向 URI 完全匹配。
• extraScopesToConsent - 当用户需要事先同意时，其他资源的作用域。
• state - 在令牌响应中也返回的请求中包含的值。 随机生成的唯一值通常用于防止跨站点请求伪造攻击。 该状态还用于在身份验证请求发生之前对应用中用户状态的信息进行编码。
• prompt - 指示所需的用户交互类型。 login：将强制用户在该请求上输入其凭据，取消单一登录：将确保用户未显示任何交互式提示。 如果无法通过单一登录完成请求，终结点将返回interaction_required错误同意：用户登录后将触发 OAuth 同意对话框，要求用户向应用授予权限select_account：将中断单一登录=提供帐户选择体验，其中列出了会话中的所有帐户或任何记住的帐户，或者选择使用其他帐户创建的选项： 会将用户定向到帐户创建体验而不是登录体验no_session：在对用户进行身份验证时不会读取现有会话令牌。 用户成功进行身份验证后，EVO 不会为用户创建新会话。 仅供内部使用。
• loginHint - 如果提前知道用户名/电子邮件地址，可用于预填充用户的登录页的用户名/电子邮件地址字段。 应用通常在重新身份验证期间使用此参数，使用 login_hint 或preferred_username声明从以前的登录中提取用户名。
• sid - 会话 ID，会话的唯一标识符。 作为 ID 令牌的可选声明提供。
• domainHint - 提供有关用户应用于登录的租户或域的提示。 域提示的值是租户的已注册域。
• extraQueryParameters - 添加到 /authorize 调用的自定义查询参数的字符串到字符串映射
• tokenBodyParameters - 添加到 /token 调用的自定义令牌请求正文参数的字符串映射。 仅在续订访问令牌时使用。
• tokenQueryParameters - 添加到 /token 调用的自定义查询参数的字符串映射
• 声明 - 如果Azure AD 租户管理员启用了条件访问策略，并且策略尚未满足，则例外将包含需要同意的声明。
• nonce - ID 令牌中返回的请求中包含的值。 随机生成的唯一值通常用于缓解重播攻击。
• redirectStartPage - 应在 loginRedirect 或 acquireTokenRedirect 之后返回的页面。 仅当这与 redirectUri 不同并且默认为启动请求的页面时，才应使用此方法。 当 navigateToLoginRequestUrl 配置选项设置为 false 时，将忽略此参数。
• onRedirectNavigate - 将传递 MSAL 将导航到的 URL 的回调。 在回调中返回 false 将停止导航。

SilentRequest：请求用户传递的对象以从缓存中检索令牌、使用刷新令牌续订过期的令牌，或在隐藏的 iframe 中检索代码（授权代码授予流的第一回合）。

• scopes - 应用程序请求访问的范围数组。
• authority - 应用程序从中获取令牌的颁发机构的 URL。
• correlationId - 每个请求的唯一 GUID 集，用于跟踪用于遥测目的的请求端到端。
• account - 用于查找凭据的帐户实体。
• forceRefresh - 如果为 true，则强制无提示请求进行网络调用。
• extraQueryParameters - 添加到 /authorize 调用的自定义查询参数的字符串到字符串映射。 仅在续订刷新令牌时使用。
• tokenBodyParameters - 添加到 /token 调用的自定义令牌请求正文参数的字符串映射。 仅在续订访问令牌时使用。
• tokenQueryParameters - 添加到 /token 调用的自定义查询参数的字符串到字符串映射。 仅在续订访问令牌时使用。
• redirectUri - 应用程序可以接收身份验证响应的重定向 URI。 它必须与在 Azure 门户中注册的其中一个重定向 URI 完全匹配。 仅适用于刷新令牌过期的情况。
• cacheLookupPolicy - 可以检索无提示令牌的不同方式的枚举。
• prompt - 指示所需的用户交互类型。 none：将确保用户未显示任何交互式提示。 如果无法通过单一登录完成请求，终结点将返回interaction_required错误no_session：在对用户进行身份验证时不会读取现有会话令牌。 用户成功进行身份验证后，EVO 不会为用户创建新会话。 仅供内部使用。

用户将请求对象传递给 ssoSilent 以从服务器检索代码（授权代码授予流的第一回合）

• scopes - 应用程序请求访问的范围数组（可选用于 ssoSilent 调用）
• claims - 字符串化的声明请求，请求将添加到所有 /authorize 和 /token 调用
• authority - 应用程序从中获取令牌的颁发机构的 URL。
• correlationId - 每个请求的唯一 GUID 集，用于跟踪用于遥测目的的请求端到端。
• redirectUri - 应用程序可以接收身份验证响应的重定向 URI。 它必须与在 Azure 门户中注册的其中一个重定向 URI 完全匹配。
• extraScopesToConsent - 当用户需要事先同意时，其他资源的作用域。
• state - 在令牌响应中也返回的请求中包含的值。 随机生成的唯一值通常用于防止跨站点请求伪造攻击。 该状态还用于在身份验证请求发生之前对应用中用户状态的信息进行编码。
• prompt - 指示所需的用户交互类型。 login：将强制用户在该请求上输入其凭据，取消单一登录：将确保用户未显示任何交互式提示。 如果无法通过单一登录完成请求，终结点将返回interaction_required错误同意：将在用户登录后触发 OAuth 同意对话框，要求用户向应用授予权限select_account：将中断单一登录=提供帐户选择体验，其中列出了会话中的所有帐户或任何记住的帐户，或者选择使用其他帐户创建的选项： 会将用户定向到帐户创建体验而不是登录体验no_session：在对用户进行身份验证时不会读取现有会话令牌。 用户成功进行身份验证后，EVO 不会为用户创建新会话。 仅供内部使用。
• loginHint - 如果提前知道用户名/电子邮件地址，可用于预填充用户的登录页的用户名/电子邮件地址字段。 应用通常在重新身份验证期间使用此参数，使用 login_hint 或preferred_username声明从以前的登录中提取用户名。
• sid - 会话 ID，会话的唯一标识符。 作为 ID 令牌的可选声明提供。
• domainHint - 提供有关用户应用于登录的租户或域的提示。 域提示的值是租户的已注册域。
• extraQueryParameters - 添加到 /authorize 调用的自定义查询参数的字符串到字符串映射
• tokenBodyParameters - 添加到 /token 调用的自定义令牌请求正文参数的字符串映射。 仅在续订访问令牌时使用。
• tokenQueryParameters - 添加到 /token 调用的自定义查询参数的字符串映射
• nonce - ID 令牌中返回的请求中包含的值。 随机生成的唯一值通常用于缓解重播攻击。

针对同一用户的租户的不同帐户详细信息

AuthMethodRegistrationChallengeMethodResult 中可能状态的类型定义。

AuthMethodRegistrationSubmitChallengeResult 中可能状态的类型定义。

GetAccessTokenResult 的可能状态。 这包括：

• GetAccessTokenCompletedState：已成功检索访问令牌。
• GetAccessTokenFailedState：访问令牌检索失败。

GetAccountResult 的可能状态。 这包括：

• GetAccountCompletedState：已成功检索帐户。
• GetAccountFailedState：帐户检索失败。

MfaRequestChallengeResult 的可能状态。 这包括：

• MfaVerificationRequiredState：用户需要验证其质询。
• MfaFailedState：MFA 请求失败。

ResetPasswordResendCodeResult 的可能状态。 这包括：

• ResetPasswordCodeRequiredState：重置密码过程需要代码。
• ResetPasswordFailedState：重置密码过程失败。

ResetPasswordStartResult 的可能状态。 这包括：

• ResetPasswordCodeRequiredState：重置密码过程需要代码。
• ResetPasswordFailedState：重置密码过程失败。

ResetPasswordSubmitCodeResult 的可能状态。 这包括：

• ResetPasswordPasswordRequiredState：重置密码过程需要密码。
• ResetPasswordFailedState：重置密码过程失败。

ResetPasswordSubmitPasswordResult 的可能状态。 这包括：

• ResetPasswordCompletedState：重置密码过程已成功完成。
• ResetPasswordFailedState：重置密码过程失败。

SignInResendCodeResult 的可能状态。 这包括：

• SignInCodeRequiredState：登录过程需要代码。
• SignInFailedState：登录过程失败。

SignInResult 的可能状态。 这包括：

• SignInCodeRequiredState：登录过程需要代码。
• SignInPasswordRequiredState：登录过程需要密码。
• SignInFailedState：登录过程失败。
• SignInCompletedState：登录过程已完成。
• AuthMethodRegistrationRequiredState：登录过程需要身份验证方法注册。
• MfaAwaitingState：登录过程需要 MFA。

SignInSubmitCodeResult 的可能状态。 这包括：

• SignInCompletedState：登录过程已成功完成。
• SignInFailedState：登录过程失败。
• AuthMethodRegistrationRequiredState：用户需要注册身份验证方法。
• MfaAwaitingState：用户处于多重身份验证（MFA）等待状态。

SignInSubmitPasswordResult 的可能状态。 这包括：

• SignInCompletedState：登录过程已成功完成。
• SignInFailedState：登录过程失败。
• AuthMethodRegistrationRequiredState：登录过程需要身份验证方法注册。
• MfaAwaitingState：登录过程需要 MFA。

SignOutResult 的可能状态。 这包括：

• SignOutCompletedState：注销操作成功。
• SignOutFailedState：注销操作失败。

SignUpResendCodeResult 的可能状态。 这包括：

• SignUpCodeRequiredState：注册过程需要代码。
• SignUpFailedState：注册过程失败。

SignUpResult 的可能状态。 这包括：

• SignUpCodeRequiredState：注册过程需要代码。
• SignUpPasswordRequiredState：注册过程需要密码。
• SignUpAttributesRequiredState：注册过程需要其他属性。
• SignUpFailedState：注册过程失败。

SignUpSubmitAttributesResult 的可能状态。 这包括：

• SignUpCompletedState：注册过程已成功完成。
• SignUpFailedState：注册过程失败。

SignUpSubmitCodeResult 的可能状态。 这包括：

• SignUpPasswordRequiredState：注册过程需要密码。
• SignUpAttributesRequiredState：注册过程需要其他属性。
• SignUpCompletedState：注册过程已成功完成。
• SignUpFailedState：注册过程失败。

SignUpSubmitPasswordResult 的可能状态。 这包括：

• SignUpAttributesRequiredState：注册过程需要其他属性。
• SignUpCompletedState：注册过程已成功完成。
• SignUpFailedState：注册过程失败。

通过 PerformanceClient 测量其性能来检测的操作的枚举。

日志消息级别。

创建 NestedAppAuthController 并将其传递给 PublicClientApplication，如果 NestedAppAuthController 不可用，则回退到 StandardController

使用 StandardController 创建 PublicClientApplication

检查平台代理是否在当前环境中可用。

用于遥测目的的 API 代码。 0-99 无提示流 800-899 身份验证代码流 900-999 杂项

身份验证请求的类型

当前正在进行的交互类型。 当某些交互正在进行或所有交互完成时，在包装库中的事件中用于调用函数。

MSAL 支持的协议模式。

服务器响应类型的允许值

包含错误代码和消息使用的字符串常量的 AuthErrorMessage 类。

BrowserAuthErrorMessage 类，其中包含错误代码和消息使用的字符串常量。

BrowserAuthErrorMessage 类，其中包含错误代码和消息使用的字符串常量。

错误代码和消息使用的字符串常量。

ClientConfigurationErrorMessage 类，包含错误代码和消息使用的字符串常量。

SDK 定义的交互所需的错误

我们考虑在请求而不是字符串中发出此“枚举”，但看起来像允许的提示值列表在过去几年中不断更改。 某些内部合作伙伴也有一些未记录的提示值，因此选择泛型“string”类型而不是“枚举”