了解 API 授权和令牌缓存

已完成

公司门户的设计包括从Microsoft Graph读取已登录用户的个人资料。 身份验证会将用户标识到门户,但 API 调用还需要具有适当权限的访问令牌。

本单元介绍权限类型、范围和说明性 MSAL4J 令牌缓存模式。 它不假定应用程序或已登录会话正在运行。

API 权限和范围

受保护的 API 定义其功能和数据的权限。 例如,Microsoft Graph具有读取配置文件、读取日历和发送邮件的不同权限。 应用程序仅请求其预期操作所需的权限。

Microsoft Entra ID支持两种权限类型:

权限类型 背景 同意
委托权限 应用程序代表已登录用户执行操作。 访问权限受授予的权限和用户的访问权限约束。 用户或授权管理员可以根据权限和租户策略授予许可。
应用程序权限 应用程序可在没有已登录用户的情况下以自身身份运行,例如作为后台服务运行。 需要管理员同意。

门户使用 委派权限 User.Read 来读取已登录用户的个人资料。 此权限不会向每个用户的数据或不相关的资源(如日历)授予访问权限。

权限范围描述所请求的访问权限

在委派的授权请求中,OAuth 2.0 范围表示应用程序请求的权限。 范围可以同时标识资源和权限;例如,https://graph.microsoft.com/Calendars.Read请求Microsoft Graph的日历读取权限。

这些示例使用单个范围 User.Read。 对于Microsoft Graph范围,可以省略资源标识符,因此表示https://graph.microsoft.com/User.Read。 有关详细信息,请参阅 范围和权限。

配置的 API 权限、请求的范围和同意是不同的。 向应用注册添加 API 权限本身不会授予许可或更改应用程序代码请求的范围。

访问令牌是针对特定 API 的

访问令牌适用于特定资源。 用于Microsoft Graph的令牌不能与另一个 API 的令牌互换,ID 令牌不能替代 API 访问令牌。

MSAL4J 获取和缓存令牌。 应用程序应将令牌用于其预定用途,而不是通过解析令牌来推断已登录用户的身份,也不应将其视为可重复使用的授权代码。

说明性静默令牌获取

对于以后的请求,Web 应用程序可以请求 MSAL 获取令牌,而无需通过另一个登录交互向用户发送令牌。 以下片段改编自参考示例的 AuthHelper片段。 这说明了如何恢复与会话关联的缓存,以及如何为该上下文中已存在的帐户请求令牌。

final SilentParameters parameters = SilentParameters
                                        .builder(Collections.singleton(Config.SCOPES), context.getAccount())
                                        .build();

final ConfidentialClientApplication client = getConfidentialClientInstance();
client.tokenCache().deserialize(context.getTokenCache());

final IAuthenticationResult result = client.acquireTokenSilently(parameters).get();

SilentParameters 标识请求的范围和帐户。 在此示例中, Config.SCOPES 包含 User.Read并 context 提供与经过身份验证的会话关联的帐户和序列化缓存。 这些是示例应用程序帮助程序,而不是学习者需要获取的值。

还原缓存后, acquireTokenSilently 尝试在不与用户交互的情况下满足请求。 它可以返回可用缓存访问令牌,或使用缓存的刷新令牌(如果适用)。 “静默”并不一定意味着不会发起网络请求。

此片段省略周围的缓存持久性和异常处理。 如果 MSAL 指示需要用户交互,Web 应用程序将启动新的授权请求并处理生成的回调。 它不会再次兑换旧授权代码。 其他故障(如网络或配置错误)需要适当的错误处理,而不是无条件登录循环。

令牌缓存和会话数据包含敏感信息。 完整的应用程序必须保护该数据,将其与正确的帐户和会话相关联,并相应地保留缓存更改。

在 API 调用之前解释结果

成功获取令牌后,会返回一个 IAuthenticationResult,其中包含访问令牌以及有关其有效期和账户上下文的信息。 对于Microsoft Graph请求,应用程序将图形访问令牌提供给其 HTTP 客户端或 Graph 身份验证提供程序。

MSAL4J 不会仅通过获取该令牌来读取用户的个人资料。 单独的 API 请求执行数据操作。

Microsoft Graph提供资源

Microsoft Graph 通过https://graph.microsoft.com提供对 Microsoft 云数据和服务的访问。 /v1.0/me 端点表示当前已登录的用户,并且需要委托用户上下文。

下一个单元将介绍向该终结点发出的一个示例请求,以及通过 Java Graph SDK 发出的等效请求。 Microsoft Graph概述描述了更广泛的 API。