OfficeRuntime.AuthOptions interface

警告

现已弃用此 API。

Use the Office.AuthOptions interface instead.

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

注解

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

使用方

示例

const options: OfficeRuntime.AuthOptions = {
  allowSignInPrompt: true,
  allowConsentPrompt: true,
  forMSGraphAccess: true,
};
const accessToken = await OfficeRuntime.auth.getAccessToken(options);

属性

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

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

forceAddAccount

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

forceConsent

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

forMSGraphAccess

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

属性详细信息

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

导致 Office 在 Microsoft Graph 所面向的租户需要多重身份验证时提示用户提供其他因素。 字符串值标识所需附加因子的类型。 在大多数情况下,你在开发时不知道用户的租户是否需要其他因素或字符串应该是什么。 因此,此选项将在 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 通过返回描述性错误) Graph 访问是否会失败来事先通知加载项 (。

forMSGraphAccess?: boolean;

属性值

boolean

注解

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