OfficeRuntime.AuthOptions interface

包:

office-runtime

为 Office 使用 getAccessToken 方法从 AAD v.2.0 获取加载项的访问令牌时提供用户体验选项。

注解

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

属性

allowConsentPrompt	允许 Office 以无提示方式或通过交互式同意获取访问令牌（如果需要）。 默认值为 false。 如果设置为 false，Office 将无提示地尝试获取访问令牌。 如果无法执行此操作，Office 将返回描述性错误。 如果设置为 true，Office 将在无法以无提示方式获取访问令牌后显示交互式同意 UI。 该提示将仅允许同意 AAD 配置文件范围，而不允许同意任何Microsoft Graph 范围。
allowSignInPrompt	允许 Office 以无提示方式获取访问令牌，前提是同意存在或显示交互式 UI 以登录用户。 默认值为 false。 如果设置为 false，Office 将无提示地尝试获取访问令牌。 如果无法执行此操作，Office 将返回描述性错误。 如果设置为 true，Office 将在无法以无提示方式获取访问令牌后显示交互式登录 UI。
asyncContext	在传递给回调的 AsyncResult 对象的 属性中asyncContext返回的任何类型的用户定义项，未更改。
authChallenge	当Microsoft Graph 针对的租户需要多重身份验证时，导致 Office 提示用户提供附加因素。 字符串值标识所需的附加因素的类型。 在大多数情况下，在开发时，你不会知道用户的租户是否需要附加因素或字符串应该是什么。 因此，在 Microsoft Graph 发送了请求附加因素并包含应与 authChallenge 选项一起使用的getAccessToken字符串的错误后，此选项将在 的“第二次尝试”调用中使用。
forceAddAccount	提示用户添加其 Office 帐户 (或切换到该帐户（如果已添加到) ）。 默认值为 false。
forceConsent	导致 Office 显示加载项同意体验。 如果加载项的 Azure 权限已更改或用户的同意已被撤销，则很有用。 默认值为 false。
forMSGraphAccess	当加载项想要访问 Microsoft Graph 且用户/管理员未授予 Graph 范围的许可时，导致 Office 返回描述性错误。 默认值为 false。 仅当租户管理员部署了加载项时，Office 才支持同意 Graph 范围。将此选项设置为 true 将导致 Office 在图形访问失败时返回描述性错误) ，从而事先通知加载项 (。

属性详细信息

allowConsentPrompt

允许 Office 以无提示方式或通过交互式同意获取访问令牌（如果需要）。 默认值为 false。 如果设置为 false，Office 将无提示地尝试获取访问令牌。 如果无法执行此操作，Office 将返回描述性错误。 如果设置为 true，Office 将在无法以无提示方式获取访问令牌后显示交互式同意 UI。 该提示将仅允许同意 AAD 配置文件范围，而不允许同意任何Microsoft Graph 范围。

allowConsentPrompt?: boolean;

属性值

boolean

allowSignInPrompt

允许 Office 以无提示方式获取访问令牌，前提是同意存在或显示交互式 UI 以登录用户。 默认值为 false。 如果设置为 false，Office 将无提示地尝试获取访问令牌。 如果无法执行此操作，Office 将返回描述性错误。 如果设置为 true，Office 将在无法以无提示方式获取访问令牌后显示交互式登录 UI。

allowSignInPrompt?: boolean;

属性值

boolean

asyncContext

在传递给回调的 AsyncResult 对象的 属性中asyncContext返回的任何类型的用户定义项，未更改。

asyncContext?: any;

属性值

any

authChallenge

当Microsoft Graph 针对的租户需要多重身份验证时，导致 Office 提示用户提供附加因素。 字符串值标识所需的附加因素的类型。 在大多数情况下，在开发时，你不会知道用户的租户是否需要附加因素或字符串应该是什么。 因此，在 Microsoft Graph 发送了请求附加因素并包含应与 authChallenge 选项一起使用的getAccessToken字符串的错误后，此选项将在 的“第二次尝试”调用中使用。

authChallenge?: string;

属性值

string

forceAddAccount

警告

现已弃用此 API。

Use allowSignInPrompt instead.

提示用户添加其 Office 帐户 (或切换到该帐户（如果已添加到) ）。 默认值为 false。

forceAddAccount?: boolean;

属性值

boolean

forceConsent

警告

现已弃用此 API。

Use allowConsentPrompt instead.

导致 Office 显示加载项同意体验。 如果加载项的 Azure 权限已更改或用户的同意已被撤销，则很有用。 默认值为 false。

forceConsent?: boolean;

属性值

boolean

forMSGraphAccess

当加载项想要访问 Microsoft Graph 且用户/管理员未授予 Graph 范围的许可时，导致 Office 返回描述性错误。 默认值为 false。 仅当租户管理员部署了加载项时，Office 才支持同意 Graph 范围。将此选项设置为 true 将导致 Office 在图形访问失败时返回描述性错误) ，从而事先通知加载项 (。

forMSGraphAccess?: boolean;

属性值

boolean

注解

注意：如果要开发使用单一登录 (SSO) 的 Outlook 加载项，请在旁加载加载项进行测试之前注释掉 forMSGraphAccess 选项。 否则，将收到 错误 13012。 有关其他指南，请参阅 有关使用 Outlook 加载项的 SSO 的详细信息。