使用 Microsoft Teams 选项卡内的 MSAL2 提供程序Microsoft Teams便于身份验证和 Microsoft Graph访问所有组件。 该提供程序可用于 SSO 登录或 (登录) 登录。
若要了解更多信息,请参阅 提供程序。
提示: 有关如何使用 Microsoft Teams MSAL2 提供程序创建 Teams 应用程序的详细信息,请参阅使用 SSO 生成 Microsoft Teams 选项卡Microsoft Teams生成 应用程序选项卡。
MSAL2 Teams提供程序Teams的不同之处
与 Teams 提供程序不同,Teams MSAL2 提供程序支持单一登录 (SSO) 并且构建于 msal-browser 上,用于客户端身份验证。 msal-browser 使用 PKCE 实现 OAuth 2.0 Flow代码。 由于授权Flow被视为比 Web 应用程序的隐式授权Flow安全,因此我们建议对 Teams 提供程序使用 Teams MSAL2 提供程序。 有关与隐式授予流相关的安全问题的详细信息,请参阅 隐式流的缺点。
所有新应用程序应尽可能Teams MSAL2 提供程序。
入门
提供程序可在交互式客户端身份验证模式或 SSO 模式下使用。
客户端身份验证
在客户端身份验证 (或交互式) ,用户首次启动应用时将要求他们进行身份验证。 用户将需要使用登录按钮启动身份验证流程。 可以在客户端上完成此操作,并且不需要后端服务。
SSO 身份验证
为了避免要求用户向应用进行身份验证,Microsoft Teams选项卡还可使用 SSO 自动对用户进行身份验证。 但是,此过程需要后端服务,该服务用于将Microsoft Teams提供的令牌与可用于访问 Microsoft Graph 的访问令牌交换。
Teams MSAL2 提供程序支持 SSO 模式,ssoUrl \ sso-url当设置为能够交换令牌的后端服务。 后端服务需要公开 API api/token (如) ,它将从 Microsoft Teams 接收身份验证令牌,on-behalf-of并使用流交换令牌,获取可以访问 Microsoft Graph 的访问令牌。 有关节点后端服务的参考实现,请参阅Microsoft Teams节点 SSO 示例。
初始化提供程序
使用 MSAL2 Teams之前,请确保在页面中引用 Microsoft Teams SDK。
在主代码中Teams MSAL2 提供程序。
npm
在 JavaScript Teams MSAL2 提供程序时,请确保同时安装工具包和 Microsoft Teams SDK。
npm install @microsoft/teams-js @microsoft/mgt-element @microsoft/mgt-teams-msal2-provider
接下来,导入并使用提供程序。
import {Providers} from '@microsoft/mgt-element';
import {TeamsMsal2Provider} from '@microsoft/mgt-teams-msal2-provider';
import * as MicrosoftTeams from "@microsoft/teams-js";
TeamsMsal2Provider.microsoftTeamsLib = MicrosoftTeams;
Providers.globalProvider = new TeamsMsal2Provider(config);
其中 config 是
export interface TeamsMsal2Config {
clientId: string;
authPopupUrl: string; // see below for creating the popup page
scopes?: string[];
msalOptions?: Configuration;
ssoUrl?: string; // ex: '/api/token',
autoConsent?: boolean,
httpMethod: HttpMethod; //ex HttpMethod.POST
}
unpkg
<!-- Microsoft Teams sdk must be referenced before the toolkit -->
<script src="https://unpkg.com/@microsoft/teams-js/dist/MicrosoftTeams.min.js" crossorigin="anonymous"></script>
<script src="https://unpkg.com/@microsoft/mgt/dist/bundle/mgt-loader.js"></script>
<mgt-teams-msal2-provider
client-id="<YOUR_CLIENT_ID>"
auth-popup-url="/AUTH-PATH"
scopes="user.read,people.read..."
authority=""
sso-url="/api/token"
http-method="POST">
></mgt-teams-msal2-provider>
| 属性 | 说明 |
|---|---|
| client-id | 字符串客户端 ID (配置你的Teams应用。 必需项。 |
| auth-popup-url | 将在弹出窗口中处理身份验证的页面的绝对路径或相对路径 (创建 弹出窗口页面) 。 必需项。 |
| scopes | 用户登录时必须同意的范围的逗号分隔字符串。 可选。 |
| authority | 颁发机构字符串。 默认值为公共颁发机构。 对于单租户应用,请使用租户 ID 或租户名称。 例如,https://login.microsoftonline.com/[your-tenant-name].onmicrosoft.com 或 https://login.microsoftonline.com/[your-tenant-id]。 可选。 |
| sso-url | 处理 OBO 令牌交换的后端 API 的绝对路径或相对路径。 可选。 |
| http-method | 用于调用后端 API 的 HTTP 方法的类型。 POST 或 GET)。 默认值为“GET”。 可选 |
创建弹出页
若要使用你的 Teams 凭据登录并处理同意,你需要提供 Teams 应用将在弹出窗口中打开的 URL,这将遵循身份验证流程。 例如,在应用程序中创建新 (, https://mydomain.com/auth) 该页面将处理身份验证重定向并调用 TeamsMsal2Provider.handleAuth 方法。 这是此页面唯一需要执行的事情。 例如:
npm
import * as MicrosoftTeams from "@microsoft/teams-js/dist/MicrosoftTeams";
import {TeamsMsal2Provider} from '@microsoft/mgt-teams-msal2-provider';
TeamsMsal2Provider.microsoftTeamsLib = MicrosoftTeams;
TeamsMsal2Provider.handleAuth();
unpkg
<script src="https://unpkg.com/@microsoft/teams-js/dist/MicrosoftTeams.min.js" crossorigin="anonymous"></script>
<script src="https://unpkg.com/@microsoft/mgt/dist/bundle/mgt-loader.js"></script>
<script>
mgt.TeamsMsal2Provider.handleAuth();
</script>
配置 Teams 应用
如果你刚开始使用应用Teams,请参阅将选项卡添加到Microsoft Teams应用中。 您还可以使用 App Studio 开发应用清单。
创建应用/客户端 ID
若要详细了解如何注册应用和获取交互式身份验证的客户端 ID,请参阅创建Azure Active Directory应用。
若要详细了解如何注册应用并获取 SSO 的客户端 ID 和密码,请参阅使用单一登录Microsoft Teams生成客户端 ID 和密码。
从 Teams 提供程序迁移到Teams MSAL2 提供程序
若要将使用 Teams 提供程序的应用程序迁移到 TEAMS MSAL2 提供程序:
-
转到 上Azure 门户。https://portal.azure.com
-
从菜单中,选择"Azure Active Directory "。
-
从"Azure Active Directory"菜单中,选择"应用注册 "。
-
选择当前使用的应用的应用注册。
-
在左侧菜单上,转到"身份验证 "。
-
在 "平台配置"下 ,选择"添加平台" ,然后选择 "单页应用程序"。
-
删除当前在 Web 下注册的所有重定向 URI,并改为将它们添加到 单页应用程序下。
-
在你的代码中,将 TeamsProvider 替换为Teams MSAL2 提供程序。
如果要在 JS/TS 代码中初始化提供程序,请按照以下步骤操作:
将 的 import 语句替换为
mgt-teams-providerimport {TeamsMsal2Provider} from '@microsoft/mgt-teams-msal2-provider';将 MsalProvider 的初始化替换为
Providers.globalProvider = new TeamsMsal2Provider(config);如果以 HTML 格式初始化提供程序,请替换
<mgt-teams-provider client-id="<YOUR_CLIENT_ID>" auth-popup-url="/AUTH-PATH" ... ></mgt-teams-provider>具有 的
<mgt-teams-msal2-provider client-id="<YOUR_CLIENT_ID>" auth-popup-url="/AUTH-PATH" ... ></mgt-teams-msal2-provider>
另请参阅
历史资料。此文对应 2023-02-03 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 sebastienlevert)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
