MSAL2 提供程序使用 msal-browser 登录用户并获取与 Microsoft Graph 一Graph。
若要了解更多信息,请参阅 提供程序。
MSAL2 提供程序和 MSAL 提供程序的区别
尽管用法相似,但 MSAL 提供程序和 MSAL2 提供程序构建在不同的 OAuth 流上。 MSAL 提供程序基于实现 OAuth2.0 隐式msal.js的 Flow。 MSAL2 提供程序基于 msal-browser 构建,它使用 PKCE 实现 OAuth 2.0 Flow代码。 由于授权代码Flow Web 应用程序的隐式授权Flow,我们建议使用 Msal2Provider 而不是 MsalProvider。 有关与隐式授予流相关的安全问题的详细信息,请参阅 隐式流的缺点。
所有新应用程序应尽可能使用 MSAL2 提供程序。
入门
可以使用 HTML 或 JavaScript 初始化 MSAL2 提供程序。
在 HTML 页中初始化
使用 HTML 初始化 MSAL2 提供程序是创建新提供程序的最简单方法。 mgt-msal2-provider使用该组件设置 client-id 和其他属性。 这将创建一个 PublicClientApplication 将用于所有身份验证和获取令牌的新实例。
<mgt-msal2-provider client-id="<YOUR_CLIENT_ID>"
login-type="redirect/popup"
scopes="user.read,people.read"
redirect-uri="https://my.redirect/uri"
authority="">
</mgt-msal2-provider>
| 属性 | 说明 |
|---|---|
| client-id | 字符串客户端 ID (创建应用/客户端 ID) 。 必需项。 |
| login-type | 和 之间的枚举 redirect popup - 默认值为 redirect。 可选。 |
| scopes | 用户登录时必须同意的范围的逗号分隔字符串。 可选。 |
| authority | 颁发机构字符串 - 默认为公共颁发机构。 对于单租户应用,请使用租户 ID 或租户名称。 例如,https://login.microsoftonline.com/[your-tenant-name].onmicrosoft.com 或 https://login.microsoftonline.com/[your-tenant-id]。 可选。 |
| redirect-uri | 重定向 URI 字符串 - 默认情况下,使用当前窗口 URI。 可选。 |
| 提示 | 用于登录的提示类型,介于 和 SELECT_ACCOUNT``````CONSENT 之间LOGIN。 默认值为“SELECT_ACCOUNT”。 可选。 |
在 JavaScript 中初始化
可以通过在 JavaScript 中初始化提供程序来提供更多选项。
import {Providers} from '@microsoft/mgt-element';
import {Msal2Provider, Msal2Config, Msal2PublicClientApplicationConfig} from '@microsoft/mgt-msal2-provider';
// initialize the auth provider globally
Providers.globalProvider = new Msal2Provider(config: Msal2Config | Msal2PublicClientApplicationConfig);
您可以通过两种方式 Msal2Provider 配置构造函数参数,如以下各节所述。
clientId提供 以创建新PublicClientApplication
当 Microsoft Graph Toolkit负责应用程序中的所有身份验证时,此选项很有意义。
interface Msal2Config {
clientId: string;
scopes?: string[];
authority?: string;
redirectUri?: string;
loginType?: LoginType; // LoginType.Popup or LoginType.Redirect (redirect is default)
prompt?: PromptType; // PromptType.CONSENT, PromptType.LOGIN or PromptType.SELECT_ACCOUNT
sid?: string; // Session ID
loginHint?: string;
domainHint?: string;
options?: Configuration // msal-browser Configuration object
}
在 属性中 PublicClientApplication 传递 publicClientApplication 现有的 。
当你的应用使用 MSAL 功能(Msal2Provider除了由 Microsoft 和其他 Microsoft 服务公开的功能Graph Toolkit此功能。 当框架自动 PublicClientApplication 实例化并公开 时,这尤其适用;例如,在使用 msal-angular 时。 有关进一步指导,angular-app请参阅 Microsoft Graph Toolkit中的示例。
请务必了解使用此选项时发生冲突的机会。 从本质上说, Msal2Provider 存在可以更改会话状态的风险;例如,让用户登录或同意其他范围。 请确保应用和其他框架在状态中流畅地响应这些更改,或考虑改为使用 自定义提供程序 。
interface Msal2PublicClientApplicationConfig {
publicClientApplication: PublicClientApplication;
scopes?: string[];
authority?: string;
redirectUri?: string;
loginType?: LoginType; // LoginType.Popup or LoginType.Redirect (redirect is default)
prompt?: PromptType; // PromptType.CONSENT, PromptType.LOGIN or PromptType.SELECT_ACCOUNT
sid?: string; // Session ID
loginHint?: string;
domainHint?: string;
options?: Configuration // msal-browser Configuration object
}
创建应用/客户端 ID
若要详细了解如何注册应用和获取客户端 ID,请参阅创建Azure Active Directory应用。
从 MSAL 提供程序迁移到 MSAL2 提供程序
若要将使用 MSAL 提供程序的应用程序迁移到 MSAL2 提供程序:
-
转到 上Azure 门户。https://portal.azure.com
-
从菜单中,选择"Azure Active Directory "。
-
从"Azure Active Directory"菜单中,选择"应用注册 "。
-
选择当前使用的应用的应用注册。
-
转到左侧 菜单 上的"身份验证"。
-
在 "平台配置"下,单击 "添加平台", 然后选择 "单页应用程序"。
-
删除当前在 Web 下注册的所有重定向 URI,并改为将它们添加到 单页应用程序下。
-
在代码中,将 替换为
MSALProviderMSAL2Provider。如果要在 JS/TS 代码中初始化提供程序,请按照以下步骤操作:
将 的 import 语句替换为
mgt-msal-providerimport {Msal2Provider, PromptType} from '@microsoft/mgt-msal2-provider';将 MsalProvider 的初始化替换为
Providers.globalProvider = new Msal2Provider({ clientId: 'REPLACE_WITH_CLIENTID' ... })如果以 HTML 格式初始化提供程序,请替换
<mgt-msal-provider client-id="" ... ></mgt-msal-provider>具有 的
<mgt-msal2-provider client-id="" ... ></mgt-msal2-provider>有关详细信息,请参阅 HTML 页面中的 Initialize。
历史资料。此文对应 2023-02-03 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 sebastienlevert)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
