OfficeRuntime.Auth interface

包含与授权相关的 API 的接口。

注解

此接口中的方法与接口中的方法 Office.auth 等效。 如果将来会添加新的身份验证类型,则只会将新身份验证类型添加到 Office.auth 接口。 为简单起见,整个文档中的代码示例都使用 Office.auth.

方法

getAccessToken(options)

调用 Azure Active Directory V 2.0 终结点以获取令牌来访问加载项的 Web 应用程序。 启用外接程序以标识用户。 服务器端代码可以使用"代表"OAuth Graph访问加载项 Web 应用程序的 Microsoft 应用程序. 此 API 需要将加载项桥接到 Azure 应用程序的单一登录配置。 Office 用户使用组织帐户和 Microsoft 帐户登录。 Microsoft Azure 返回适用于两种用户帐户类型的令牌,以访问 Microsoft Graph 中的资源。

重要 提示:Outlook,如果外接程序加载到 Outlook.com 或 Gmail 邮箱中,则不支持此 API。

方法详细信息

getAccessToken(options)

调用 Azure Active Directory V 2.0 终结点以获取令牌来访问加载项的 Web 应用程序。 启用外接程序以标识用户。 服务器端代码可以使用"代表"OAuth Graph访问加载项 Web 应用程序的 Microsoft 应用程序. 此 API 需要将加载项桥接到 Azure 应用程序的单一登录配置。 Office 用户使用组织帐户和 Microsoft 帐户登录。 Microsoft Azure 返回适用于两种用户帐户类型的令牌,以访问 Microsoft Graph 中的资源。

重要 提示:Outlook,如果外接程序加载到 Outlook.com 或 Gmail 邮箱中,则不支持此 API。

getAccessToken(options?: AuthOptions): Promise<string>;

参数

options
OfficeRuntime.AuthOptions

可选。 接受 AuthOptions 对象以定义登录行为。

返回

Promise<string>

承诺访问令牌。

注解

主机:Excel、Outlook、PowerPoint、Word