使应用程序成为多租户

  • 项目

如果你向许多组织提供服务型软件 (SaaS) 应用程序，可以配置应用程序，将其转换为多租户，从而接受来自任何 Azure Active Directory (Azure AD) 租户的登录。 任何 Azure AD 租户中的用户在同意配合应用程序使用其帐户之后，便可登录到应用程序。

对于有自己的帐户系统的现有应用（或来自其他云提供商的其他登录），应通过 OAuth2、OpenID Connect 或 SAML 添加登录代码，并按下应用程序中的“使用 Microsoft 登录”按钮。

在本操作指南中，你需要执行将单租户应用转换为 Azure AD 多租户应用所需的 4 个步骤：

  1. 将应用程序注册更新为多租户
  2. 将代码更新为向 /common 终结点发送请求
  3. 将代码更新为处理多个颁发者值
  4. 了解用户和管理员的同意意向并进行适当的代码更改

也可参考示例：构建使用 Azure AD 和 OpenID Connect 调用 Microsoft Graph 的多租户 SaaS Web 应用程序。 本操作指南假设你熟悉如何为 Azure AD 构建单租户应用程序。 如果不熟悉，请先查看开发人员指南主页上的快速入门之一。

将注册更新为多租户

Azure AD 中的 Web 应用/API 注册在创建时默认为单租户。 若要使注册成为多租户，请在 Azure 门户中应用程序注册的“身份验证”窗格中查找“支持的帐户类型”部分。 将设置更改为“任何组织目录中的帐户”。

通过 Azure 门户创建单租户应用程序时，概述页面上列出的其中一项是应用程序 ID URI。 这是在协议消息中标识应用程序的方式之一，可以随时添加。 单租户应用的应用 ID URI 在该租户中可保持全局唯一。 相比之下，对于多租户应用，该 URI 在所有租户中必须全局唯一，这样确保了 Azure AD 可在所有租户中找到该应用。

例如，如果租户的名称为 contoso.partner.onmschina.cn，则有效的应用 ID URI 为 https://contoso.partner.onmschina.cn/myapp。 如果应用程序 ID URI 不遵循此模式，则将应用程序设置为多租户就会失败。

将代码更新为向 /common 发送请求

使用多租户应用程序时，由于应用程序无法立即知道用户来自哪个租户，因此无法将请求发送到租户的终结点。 而是将请求发送到在所有 Azure AD 租户之间多路复用的终结点：https://login.partner.microsoftonline.cn/common。

编辑代码并将租户的值更改为 /common。 请务必注意，此终结点本身不是租户或颁发者。 当 Microsoft 标识平台在 /common 终结点上收到请求时，会使用户登录，从而知道用户来自哪个租户。 此终结点可与 Azure AD 支持的所有身份验证协议（OpenID Connect、OAuth 2.0、SAML 2.0 和 WS 联合身份验证）配合使用。

然后，对应用程序做出的登录响应会包含代表该用户的令牌。 令牌中的颁发者值告知应用程序该用户来自哪个租户。 从 /common 终结点返回响应时，令牌中的颁发者值将与用户的租户相对应。

将代码更新为处理多个颁发者值

Web 应用程序和 Web API 接收并验证 Microsoft 标识平台发送的令牌。 本机客户端应用程序不会验证访问令牌，必须将它们视为不透明。 相反，他们从 Microsoft 标识平台请求并接收令牌，这样做是为了将令牌发送到 API，然后在那里进行验证。 多租户应用程序无法通过将元数据中的颁发者值与令牌中的 issuer 值进行匹配来验证令牌。 多租户应用程序需要一个逻辑来根据颁发者值的租户 ID 部分来确定哪些颁发者值有效、哪些颁发者值无效。

例如，如果多租户应用程序只允许从已注册其服务的特定租户登录，则必须检查令牌中的 issuer 值或 tid 声明值，以确保该租户在其订阅者列表中。 如果多租户应用程序只处理个人而不根据租户做出任何访问决策，则可以完全忽略颁发者值。

在多租户示例中，为了使任何 Azure AD 租户都能登录，已禁用颁发者验证。 由于 /common 终结点既不对应于租户也不是颁发者，因此在检查 /common 的元数据中的颁发者值时，它有一个模板化的 URL 而不是实际值：

https://sts.chinacloudapi.cn/{tenantid}/

若要确保应用可支持多个租户，请修改代码的相关部分，确保颁发者值设置为 {tenantid}。

相比之下，单租户应用程序通常采用终结点值来构造元数据 URL，例如：

https://login.partner.microsoftonline.cn/contoso.partner.onmschina.cn/.well-known/openid-configuration

以下载用于验证令牌的两项关键信息：租户的签名密钥和颁发者值。

每个 Azure AD 租户使用以下格式的唯一颁发者值：

https://sts.chinacloudapi.cn/31537af4-6d77-4bb9-a681-d2394888ea26/

其中，GUID 值是租户的租户 ID 重命名安全版本。

单租户应用程序对令牌进行验证时，会对照来自元数据文档的签名密钥检查令牌的签名。 此测试使得它可以确保令牌中的颁发者值与在元数据文档中找到的颁发者值相匹配。

若要让用户登录 Azuer AD 中的某个应用程序，必须以用户租户的形式表示该应用程序。 这样，组织便可以采取一些措施，例如，当其租户中的用户登录应用程序时应用唯一策略。 对于单租户应用程序，可以通过 Azure 门户进行注册。

对于多租户应用程序，应用程序的初始注册是在开发人员使用的 Azure AD 租户中进行的。 当来自不同租户的用户首次登录应用程序时，Azure AD 会要求他们同意应用程序所请求的权限。 如果他们同意，系统将在用户的租户中创建一个称为“服务主体” 的应用程序表示形式，然后登录即可继续进行。 系统还会在记录用户对应用程序的同意意向的目录中创建委托。 有关应用程序的 Application 和 ServicePrincipal 对象以及它们之间关系的详细信息，请参阅应用程序对象和服务主体对象。

演示用户同意单层应用的示意图。

这种同意体验受应用程序请求的权限的影响。 Microsoft 标识平台支持两种类型的权限：仅限应用的权限和委托的权限。

  • 委托的权限授权应用程序充当登录用户来执行该用户所能执行的一部分操作。 例如，可以向应用程序授予委托的权限来读取登录用户的日历。
  • 仅限应用的权限直接授予给应用程序的标识。 例如，可以向应用程序授予仅限应用的权限来读取租户中的用户列表，无论是谁登录此应用程序，该应用程序都能够执行此操作。

有些权限可由普通用户同意，有些则需要租户管理员同意。

仅限应用的权限始终需要租户管理员的同意。 如果应用程序请求仅限应用的权限，当用户尝试登录应用程序时，会显示一条错误消息，指出该用户无法同意。

有些委托的权限也需要租户管理员的同意。 例如，若要能够以登录用户身份写回 Azure AD，就需要租户管理员的同意。 与仅限应用的权限一样，如果普通用户尝试登录请求委托权限的应用程序，而该权限需要管理员同意，则应用会收到错误。 权限是否需要管理员同意是由发布资源的开发人员决定的，可以在该资源的文档中找到相关信息。 Microsoft Graph API 的权限文档指示哪些权限需要管理员同意。

如果应用程序使用需要管理员同意的权限，请考虑添加可供管理员发起操作的按钮或链接。 应用程序针对此操作发送的请求是一个普通的 OAuth2/OpenID Connect 授权请求，但此请求同时也包含 prompt=consent 查询字符串参数。 在管理员同意且系统已在客户的租户中创建服务主体之后，后续登录请求就不再需要 prompt=consent 参数。 由于管理员已确定可接受请求的权限，因此从该时间点之后，不再提示租户中的任何其他用户同意。

租户管理员可以禁用普通用户同意应用程序的能力。 如果禁用此功能，则始终需要管理员同意，才能在租户中使用应用程序。 若要在禁用最终用户许可的情况下测试应用程序，可以在 Azure 门户的“企业应用程序”下的 用户设置 部分中找到配置开关。

prompt=consent 参数还可以由请求不需要管理员许可的权限的应用程序使用。 何时会使用此功能的一个示例是当应用程序需要如下所述的体验时，即：租户管理员“注册”一次，在此之后不再提示其他用户确认同意。

如果某个应用程序需要管理员同意并且管理员登录而没有发送 prompt=consent 参数，则当管理员成功地向该应用程序表示同意时，它仅适用于其用户帐户。 普通用户仍然无法登录或同意该应用程序。 如果想要让租户管理员浏览应用程序，然后允许其他用户访问，则此功能就很有用。

应用程序可能有多个层，每一层由其自身在 Azure AD 中的注册来表示。 例如，一个调用 Web API 的本机应用程序，或者一个调用 Web API 的 Web 应用程序。 在这两种情况下，客户端（本机应用或 Web 应用）将请求调用资源 (Web API) 的权限。 要让客户端成功获得客户同意添加到其租户中，请求权限的所有资源必须都已在于客户的租户中。 如果不符合此条件，Azuer AD 将返回错误，指出必须先添加资源。

单个租户中的多个层

如果逻辑应用程序包含两个或更多个应用程序注册（例如独立的客户端和资源），这可能造成问题。 如何先将资源添加到客户租户中？ Azure AD 通过实现在单个步骤中连接客户端和资源来涵盖了此情况。 用户在同意页面上会看到由客户端和资源请求的权限的总和。 若要启用此行为，资源的应用程序注册必须在其应用程序清单中以 knownClientApplications 形式包含客户端的应用 ID。 例如：

"knownClientApplications": ["94da0930-763f-45c7-8d26-04d5938baab2"]

在本文末尾的相关内容部分的多层本机客户端调用 Web API 示例中对此进行了演示。 下图针对在单个租户中注册的多层应用提供了同意概览。

演示如何同意已知的多层客户端应用的示意图。

多个租户中的多个层

如果在不同的租户中注册不同的应用程序层，将发生类似的情况。 例如，考虑构建一个调用 Exchange Online API 的本机客户端应用程序的情况。 如果要开发该本机应用程序，并让该本机应用程序在客户的租户中运行，必须存在 Exchange Online 服务主体。 在此情况下，开发人员和客户必须购买 Exchange Online，才能在其租户中创建服务主体。

如果它是由 Microsoft 以外的组织生成的 API，则 API 的开发人员需要提供一个可供其客户许可将其应用程序添加到客户租户中的方式。 对于第三方开发人员，建议的设计是使所生成的 API 能够同时用作 Web 客户端来实现注册。 为此，请按以下步骤操作：

  1. 根据前面各节的内容确保 API 实现多租户应用程序注册/代码要求。
  2. 除了公开 API 的范围/角色之外，还需确保注册包括“登录和读取用户配置文件”权限（默认情况下会提供）。
  3. 在 Web 客户端中实现登录/注册页面，并按照管理员同意指南操作。
  4. 当用户同意应用程序后，会在其租户中创建服务主体和同意委派链接，并且本机应用程序可以获取 API 的令牌。

下图针对在不同租户中注册的多层应用提供了同意概览。

演示如何同意多层多方应用的示意图。

用户和管理员可以随时吊销对应用程序的同意：

如果是由管理员代表租户中的所有用户对应用程序行使同意权，用户就不能单独撤销访问权限。 只有管理员才能吊销访问权限，并且只能针对整个应用程序吊销。

多租户应用程序和缓存访问令牌

多租户应用程序也可以获取访问令牌来调用受 Azure AD 保护的 API。 在多租户应用程序中使用 Microsoft 身份验证库 (MSAL) 时经常会出现一个错误，就是一开始即使用 /common 为用户请求令牌、接收响应，然后同样使用 /common 为同一用户请求后续令牌。 由于从 Azure AD 返回的响应来自租户而不是 /common，因此 MSAL 缓存令牌时将它视为来自租户。 后续为了为用户获取访问令牌而执行的 /common 调用将错过缓存项，因此系统会再次提示用户登录。 为了避免缓存未命中，请确保后续为登录用户执行的调用是针对租户的终结点发出的。

相关内容

后续步骤

本文介绍了如何将单租户应用程序转换为多租户应用程序。

若要详细了解如何对 Azure AD 和 Microsoft 365 服务（如 Exchange、SharePoint、OneDrive、OneNote 等）进行 API 调用，请访问 Microsoft Graph API。