大网数据广告活动
Microsoft Graph 接口

Microsoft Graph Toolkit提供程序

· 52CE 我爱测

Microsoft Graph Toolkit提供程序启用身份验证,并且 Microsoft Graph访问所有组件。

Microsoft Graph Toolkit提供程序使应用程序只需几行代码,就能够使用 Microsoft 标识进行身份验证Graph访问 Microsoft 服务。 每个提供程序都处理用户身份验证和获取访问令牌以调用 Microsoft Graph API,因此,你不必自己编写此代码。

你可以自行使用提供程序(无需组件)为应用快速实现身份验证,并调用 Microsoft Graph JavaScript 客户端 SDK。

使用 Microsoft Graph Toolkit组件时,提供程序是必需的,因为组件使用它们访问 Microsoft Graph。 如果你已拥有自己的身份验证并且想要使用组件,可以改为使用 自定义提供程序 。

该Toolkit包括以下提供程序。

提供程序 说明
MSAL 使用 msal.js 登录用户并获取与 Web 应用程序中的 Microsoft Graph一同使用的令牌。
MSAL2 使用 msal-browser 登录用户并获取与 Microsoft Graph Web 应用程序中的令牌。
电子 通过身份验证并提供 Microsoft Graph访问应用内的组件。
SharePoint 对 SharePoint Web 部件中的组件进行身份验证并提供对组件的 Microsoft Graph 访问权限。
Teams 使用 msal.js 登录用户并在 Microsoft Graph 选项卡的客户端中获取令牌。
Teams MSAL2 使用 msal-browser 登录用户并在 Microsoft Graph 选项卡中获取令牌。 支持使用自定义后端进行单一登录。
代理 通过后端将所有调用路由到 Microsoft Graph 以允许使用后端身份验证。
自定义 创建自定义提供程序以启用身份验证,并使用应用程序的现有身份验证代码访问 Microsoft Graph。

初始化提供程序

若要在应用中使用提供程序,你需要初始化一个新提供程序,然后在 Providers 命名空间中将它设置为全局提供程序。 我们建议在开始使用任何组件之前执行此操作。 可以通过两种方法之一执行此工作:

选项 1:使用提供程序组件

可以直接在 HTML 中使用该提供程序的组件版本。 在后台,将初始化新的提供程序并设置为全局提供程序。 以下示例演示如何使用 MSAL2 提供程序。

<script src="https://unpkg.com/@microsoft/mgt/dist/bundle/mgt-loader.js"></script>
<mgt-msal2-provider client-id="YOUR_CLIENT_ID"></mgt-msal2-provider>

选项 2:在代码中初始化

通过 JavaScript 代码初始化提供程序,可以提供更多选项。 为此,请创建一个新的提供程序实例,将 Providers.globalProvider 属性的值设置为希望使用的提供程序。 以下示例演示如何使用 MSAL2 提供程序。

import {Providers, Msal2Provider } from "@microsoft/mgt";
Providers.globalProvider = new Msal2Provider({
  clientId: 'YOUR_CLIENT_ID'
});

注意: 若要详细了解如何注册应用和获取客户端 ID,请参阅创建Azure Active Directory 应用。

权限范围

建议在初始化提供程序scopes时,将应用程序需要的所有权限范围添加到属性或属性 (这不适用于 SharePoint 提供程序) 。 这是可选的,但会通过向用户显示单个许可屏幕(即应用内所有组件请求的权限聚合列表)来改进用户体验,而不是显示每个组件的单独屏幕。 以下示例显示如何使用 MSAL2 提供程序进行此操作。

<script src="https://unpkg.com/@microsoft/mgt/dist/bundle/mgt-loader.js"></script>
<mgt-msal2-provider client-id="YOUR_CLIENT_ID"
                   scopes="user.read,people.read"
                   ></mgt-msal2-provider>

如果要在代码中初始化提供程序,请提供 属性中数组中的权限 scopes 范围。

import {Providers, Msal2Provider } from "@microsoft/mgt";
Providers.globalProvider = new Msal2Provider({
  clientId: 'YOUR_CLIENT_ID'
  scopes:['user.read','people.read']
});

您可以在每个组件的文档页的 Microsoft Graph 权限 部分找到每个组件所需的权限范围列表。

提供程序状态

提供程序跟踪用户的身份验证状态,并通知组件。 例如,当用户ProviderState``SignedIn成功登录时,将 更新为 ,向 组件发出信号,指示他们现在可以调用 Microsoft Graph。 枚举 ProviderState 定义三种状态,如下所示。

export enum ProviderState {
  Loading,
  SignedOut,
  SignedIn
}

在某些情况下,你将希望显示某些功能或仅在用户成功登录后执行某个操作。 可以访问和检查提供程序状态,如以下示例所示。

import { Providers, ProviderState } from '@microsoft/mgt'

//assuming a provider has already been initialized

if (Providers.globalProvider.state === ProviderState.SignedIn) {
  //your code here
}

您还可以使用 Providers.onProviderUpdated 方法在提供程序的状态发生更改时收到通知。

import { Providers, ProviderState } from "@microsoft/mgt";

//assuming a provider has already been initialized

const providerStateChanged = () => {
  if (Providers.globalProvider.state === ProviderState.SignedIn) {
    // user is now signed in
  }
}

// register a callback for when the state changes
Providers.onProviderUpdated(providerStateChanged);

// remove callback if necessary
Providers.removeProviderUpdatedListener(providerStateChanged);

获取访问令牌

每个提供程序都公开一个称为 getAccessToken 的函数,该函数可以检索当前访问令牌或检索提供的范围的新访问令牌。 以下示例演示如何获取具有权限范围的新访问 User.Read 令牌。

import { Providers, ProviderState } from "@microsoft/mgt";

//assuming a provider has already been initialized

if (Providers.globalProvider.state === ProviderState.SignedIn) {
  const token = await Providers.globalProvider.getAccessToken({scopes: ['User.Read']})
}

自行调用 Microsoft Graph

所有组件都可以访问 Microsoft Graph,而无需任何自定义,只要初始化提供程序 (如前面的部分所述) 。 如果你想要自行调用 Microsoft Graph,可以通过获取对组件使用的同一 Microsoft Graph SDK 的引用来这样做。 首先,获取对全局的引用 IProvider ,然后使用 graph 对象,如下所示:

import { Providers } from '@microsoft/mgt';

let provider = Providers.globalProvider;
if (provider) {
  let graphClient = provider.graph.client;
  let userDetails = await graphClient.api('me').get();
}

在某些情况下,可能需要传递其他权限,具体取决于你调用的 API。 以下示例说明了具体的操作方法。

import { prepScopes } from '@microsoft/mgt';

graphClient
  .api('me')
  .middlewareOptions(prepScopes('user.read', 'calendar.read'))
  .get();

使用多个提供程序

在某些情况下,应用程序将在不同的环境中运行,并且需要针对每个环境使用不同的提供程序。 例如,应用可能同时作为 Web 应用程序和 Microsoft Teams 选项卡运行,这意味着您可能需要同时使用 MSAL2 提供程序和 Teams MSAL2 提供程序。 对于此方案,所有提供程序组件 depends-on 都有 用于创建回退链的属性,如以下示例所示。

<mgt-teams-msal2-provider
  client-id="[CLIENT-ID]"
  auth-popup-url="auth.html" ></mgt-teams-msal2-provider>

<mgt-msal2-provider
  client-id="[CLIENT-ID]"
  depends-on="mgt-teams-provider" ></mgt-msal2-provider>

在此方案中,只有当您的应用程序作为 Web 应用程序运行并且 Teams MSAL2 提供程序在当前环境中不可用时,才使用 MSAL2 提供程序。

若要在代码中完成相同的任务,可以在 isAvailable 提供程序上使用 属性,如下所示。

if (TeamsProvider.isAvailable) {
    Providers.globalProvider = new TeamsProvider(teamsConfig);
} else {
    Providers.globalProvider = new Msal2Provider(msalConfig)
}

用户登录/注销

为应用程序初始化正确的提供程序后,可以添加Toolkit登录组件,以轻松快速地实现用户登录和注销。 该组件与提供程序一起处理所有身份验证逻辑和登录/注销功能。 以下示例使用 MSAL2 提供程序和 Login 组件。

<script src="https://unpkg.com/@microsoft/mgt/dist/bundle/mgt-loader.js"></script>
<mgt-msal2-provider client-id="YOUR_CLIENT_ID"></mgt-msal2-provider>
<mgt-login></mgt-login>

在需要自己实现此操作(而不是login``logout使用 Toolkit 登录组件的方案中,可以使用 提供程序的 和 方法来实现此方案。

实现你自己的提供程序

在想要将 Toolkit 组件添加到具有预先存在的身份验证代码的应用程序的方案中,您可以创建一个连接到身份验证机制的自定义提供程序,而不是使用预定义的提供程序。 该工具包提供两种创建新提供程序的方法:

  • 创建一 SimpleProvider 个通过传递函数从身份验证代码返回访问令牌的新建。
  • 扩展抽象 IProvider 类。

有关每个提供程序的更多详细信息,请参阅 自定义提供程序。

历史资料。此文对应 2023-02-03 的中文文档快照,适用产品版本和命令行为以原文为准。

来源与署名:Microsoft 和文档贡献者(原始作者元数据 sebastienlevert)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。

资料来源与适用范围

资料来源
Microsoft / Microsoft Graph 中文文档历史快照
适用范围
历史中文快照 2023-02-03;详见原文产品版本;文档日期 未标明
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-16
授权说明
CC BY 4.0(文档)/ MIT(示例代码)

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。