Microsoft Office 365 作用域

UiPath.MicrosoftOffice365.Activities.Office365ApplicationScope

描述

使用 Microsoft 身份平台在 UiPath 和您的 Microsoft 365 应用程序之间建立经过身份验证的连接。此经过身份验证的连接使机器人能够调用 Microsoft Graph API，以代表您读取和写入资源。

重要提示：从版本 2.5.0 预览版开始， 您可以在“作用域”活动中使用较新的 Microsoft 365 活动。 要了解如何将集成服务活动与 Microsoft 365 应用程序作用域结合使用，请参阅如何在没有集成服务连接的情况下使用 Microsoft 365 活动。

项目兼容性

Windows - Legacy | Windows

概述

要建立经过身份验证的连接，请首先在 Azure Active Directory 中注册 Microsoft 365 应用程序（使用您的个人、工作和/或学校 Microsoft 365 帐户）。注册应用程序时，您需要分配 Microsoft Graph API 权限，以指定机器人可以代表您访问的资源。

注册 Microsoft 365 应用程序后，Azure Active Directory 会分配您在Microsoft 365 作用域活动中输入的唯一应用程序（客户端）ID。 应用程序 ID 用于收集有关已注册应用程序的必要信息，以启动身份验证。

要了解有关注册应用程序和分配权限的更多信息，请参阅设置指南。 本指南提供配置 Microsoft 365 应用程序以实现自动化的分步说明。

注意：有关 API 作用域和权限的详细信息，请参阅 Microsoft 365 和 Google WorkSpace 卡 - API 权限和作用域。

身份验证类型

身份验证类型	作为用户	作为应用程序（作为后台服务运行）	有人值守	无人值守	无人值守（已启用 MFA）	详细信息
交互式令牌						您可以选择注册和使用自己的 Azure AD 应用程序（即 OAuthApplication = Custom）或 UiPath 提供的应用程序 (OAuthApplication = UiPath)。
Windows 集成身份验证 (IWA)						仅适用于联合身份验证用户，并且已注册的 Azure 应用程序配置为支持 IWA。 不适用于多重身份验证 (MFA)。 在此处查看详细信息： GitHub 上的 IWA
用户名和密码						不推荐，仅出于遗留原因提供（这违反了新式身份验证的原则）。 不适用于多重身份验证 (MFA)。 在此处查看详细信息： GitHub 上的用户和密码
应用程序 ID 和密码						建议用于无人值守执行或 当您想要在没有登录用户的情况下作为应用程序（后台服务/守护程序）访问 Microsoft Graph API 时。
应用程序 ID 和证书						从 v1.9.0 开始提供。 与应用程序 ID 和密码非常相似。 唯一的区别是使用证书作为密码，而不是客户端密码字符串。 请参阅 官方文档。

配置

• “连接方法”- 选择要使用的连接方法。 下拉菜单中的可用选项包括：
  • “属性面板”- 在“属性”面板中配置连接详细信息。
  • “资产” - 使用 Orchestrator 凭据资产。 我们建议您使用此选项。

资产连接方法

选择此选项时，“属性面板”选项中显示的身份验证字段将隐藏，因为所有身份验证信息都存储在资产中。

对于资产连接方法，当前仅支持交互式令牌。

• 连接资产- 浏览 Orchestrator 文件夹以选择资产。 此字段支持IResource变量。 选择“管理资产” 按钮以打开 Orchestrator。 可用资产列表取决于 Studio 和机器人连接到的 Orchestrator。
  • Use the Plus button menu to select Reload Assets if you've updated your assets in Orchestrator. Note that if you add a new asset in Orchestrator while using Studio Desktop, it will not be available straightaway in the Scope activity.

请参阅如何在没有 Integration Service 连接的情况下使用 Microsoft 365 活动中的资产格式。

身份验证

• “模拟用户电子邮件地址”- 模拟用户的电子邮件地址。 用于应用程序权限。

用户名和密码（无人值守）

• 用户名 - 您的 Microsoft 365 帐户的用户名。
• 密码 - 您的 Microsoft 365 帐户密码。

常见

• “超时(毫秒)”- 指定最长等待时间（以毫秒为单位），如果超出该时间后引发错误，您将无法完成交互式身份验证（同意对话框）。 此字段仅支持整数和Int32变量。 默认值为 30000 毫秒（30 秒）。

运行时

• 运行时连接资产- 浏览以选择资产。 此字段可用于为运行时选择不同的资产。 使用加号按钮菜单以选择“相对路径”，然后输入包含连接详细信息的 Orchestrator 资产的完整路径。

属性面板连接方法

注意：选择此方法时，您可以在“属性”面板中配置身份验证字段，就像此包的以前版本一样。

• 连接- 从列表中选择一个帐户。 您可以添加、删除连接，以及选择要使用的连接。
• 身份验证作用域- 请参阅下面的使用身份验证作用域向导部分。

使用身份验证作用域向导

注意：此向导将替换此包的早期版本中可用的“服务”字段。

“作用域”活动包含一个通用权限选取器，可提供活动正常运作所需的所有已使用的身份验证作用域的清晰画面。

Microsoft 365 应用程序作用域活动中包含的所有子活动都会自动检测为必需作用域。

如果未从“作用域”向导中手动选择任何作用域，则默认情况下会在运行时应用“自动检测”功能，并且无需配置向导。 在运行时选择所有最低要求的作用域。

将子活动添加到Microsoft 365 应用程序作用域后，也可以手动添加作用域。

身份验证

Important: Microsoft has deprecated Basic Authentication for Exchange online. This impacts some of our activities, such as Microsoft Office365 Scope. We recommend using the OAuth protocol in the activities that support it.

• “身份验证类型 ” - 已注册应用程序所需的身份验证类型。 选择以下五个选项之一： InteractiveToken、 IntegratedWindowsAuthentication、 UsernameAndPassword、 ApplicationIdAndSecret 或 ApplicationIdAndCertificate。 默认值为 InteractiveToken。 有关这些选项以及选择哪个选项的更多信息，请参阅下面的“ 无人值守自动化与有人值守自动化 ”部分。
• “环境” - 环境可以是 Azure Global 或独立于 Azure Global 的独特环境的国家云。 选择以下五个选项之一: 默认、全球、中国、德国或美国政府。 默认值为“全局”。
• 应用程序 ID - 您在设置过程中注册应用程序时，Azure Active Directory 分配的唯一应用程序（客户端）ID。应用程序（客户端）ID 表示 Microsoft 365 应用程序的实例。单个组织的 Microsoft 365 帐户可以有多个应用程序（客户端）ID。每个应用程序（客户端）ID 都包含其自己的权限和身份验证要求。例如，您和您的同事都可以在公司的 Azure Active Directory 中使用不同的权限注册 Microsoft 365 应用程序。可以将您的应用程序可以配置为授予仅与文件交互的权限，同时可以将您同事的应用程序配置授予与文件、邮件和日历交互的权限。如果您在此属性中输入应用程序（客户端）ID 并运行 Attended 的自动化，则同意对话框将仅请求文件访问权限（随后，只能使用文件活动）。
• “租户” - 您在安装过程中注册应用程序时，由 Azure Active Directory 分配的唯一目录（租户）ID。 多租户应用程序和集成 Windows 身份验证为必需。 目录（租户）ID 可以在已注册应用程序的概述页面（在应用程序（客户端）ID 下）找到。
• “模拟用户电子邮件地址”- 模拟用户的电子邮件地址。

常见

• “超时(毫秒)”- 指定最长等待时间（以毫秒为单位），如果超出该时间后引发错误，您将无法完成交互式身份验证（同意对话框）。 此字段仅支持整数和Int32变量。 默认值为 30000 毫秒（30 秒）（未显示）。
• 出错时继续 - 指定即使在当前活动失败的情况下，仍继续执行其余活动。

交互式令牌

注意：这与 Integration Service 中支持的身份验证方法相同，即通过公共 UiPath 应用程序或私有自定义应用程序（自带应用程序方法）进行身份验证。

• “ OAuth 应用程序”- 指定要使用的应用程序（客户端）。 如果选择了“ UiPath ”，则忽略应用程序ID 和租户。 此字段仅支持OAuthApplication变量。 选择以下选项之一：
  • UiPath - 默认。 当您要使用由 UiPath 创建的应用程序时。 在这种情况下，将忽略 应用程序 ID 和 租户 参数值。
  • “自定义” - 当您要创建具有正确权限的自己的应用程序时。 在这种情况下，必须为“ 应用程序 ID ”参数设置一个值。

应用程序 ID 和证书（无人值守）

• Base64 证书- 证书的 Base64 表示。 如果“身份验证类型”设置为“应用程序 ID 和证书”，则为必填。

• 证书密码- 使用证书时可能需要的可选密码， Secure String形式。

Application ID and Secret (Unattended)

• “应用程序密码” - 应用程序用于提供其身份的密码字符串。 如果“身份验证类型”设置为“应用程序 ID 和密码”，则为必填。
• 安全应用程序密码 - 应用程序（客户端）密码，以 SecureString形式显示。

用户名和密码（无人值守）

这些属性仅在运行 Unattended 自动化时适用。 指定这些属性的值时，请确保将“身份验证类型”和“密码”设置为“用户名”和“密码”。 有关更多信息，请参阅下面的“用户名和密码”部分。

• 密码 - 您的 Microsoft 365 帐户密码。
• 安全密码 - 您的 Microsoft 365 帐户密码，形式为 SecureString。
• 用户名 - 您的 Microsoft 365 帐户的用户名。

工作方式

以下步骤和消息序列图是活动从设计时（即活动依赖项和输入/输出属性）到运行时如何工作的示例。

1. 完成 设置 步骤。
2. 将“ Microsoft Office 365 作用域 ”活动添加到您的项目中。

3. 为 Authentication、 Input和 Unattended (如果适用) 属性输入值。

   
   

   

   
   

有人值守自动化与无人值守自动化

Microsoft 365 作用域活动有四种不同的身份验证流程（身份验证类型），在将活动添加到项目时可以从中进行选择。 您的选择取决于计划运行的自动化模式类型（无人值守或有人值守）和应用程序身份验证要求（如果您不确定哪些身份验证要求适用于您的应用程序，请咨询管理员）。

身份验证类型	有人值守	无人值守	API 权限类型
交互式令牌	X		委派权限
Windows 集成身份验证		X	委派权限
用户名和密码		X	委派权限
应用程序 ID 和密码		X	应用程序权限
应用程序 ID 和证书		X	应用程序权限

重要提示：

启用多重身份验证 (MFA) 时，集成 Windows 身份验证或用户名和密码身份验证类型不起作用。 如果您的应用程序需要 MFA，则可以使用交互式令牌身份验证类型运行有人值守的自动化，或使用应用程序 ID 和密码以及应用程序 ID 和证书运行无人值守自动化。 应用程序 ID 和密码、应用程序 ID 和证书身份验证类型适用于无人值守的自动化，并且无论是启用还是禁用 MFA，都可以正常工作。

注册应用程序时，您必须选择应用程序类型。 请考虑以下要求：

• 对于有人值守方案（交互式令牌身份验证类型）和带有集成 Windows 身份验证的无人值守，请使用移动/桌面应用程序（使用OAuth 2.0 授权代码流）。

• 对于无人值守方案（用户名和密码、应用程序 ID 和密码、应用程序 ID 和证书），请使用机密/网页应用程序（使用OAuth 2.0 客户端凭据流）。

交互式令牌

“交互式令牌”身份验证类型可用于有人值守的自动化以及需要多重身份验证 (MFA) 时的情况。 这是默认选项，也是我们在示例中使用的选项。 如果您有兴趣试用活动包，此选项易于配置，并且适用于个人帐户（使用 设置 指南 注册应用程序 部分第 7 步中记录的默认重定向 URI）。

首次使用此身份验证类型运行 Microsoft 365 活动时，系统会提示您通过同意对话框授权对资源（您在注册应用程序时授予的权限）的访问权限。

如果选择此选项，则“ 用户名”、“ 密码”和“ 租户 ”属性应留空。

Windows 集成身份验证

“集成 Windows 身份验证”身份验证类型可用于 Unattended 自动化。 此选项可适用于在加入 Windows 域或 Azure Active Directory 的计算机上运行的 Windows 托管应用程序。

仅当已注册的应用程序配置为支持集成 Windows 身份验证时，才应选择此选项（更多信息可在GitHub上找到）。

如果选择此选项，则“ 用户名 ”和“ 密码 ”属性应留空。 “ 租户 ” 属性是可选的。

用户名和密码

“用户名”和“密码”身份验证类型可用于 Unattended 自动化。

尽管 Microsoft 不建议这样做，但您可以在公共客户端应用程序中使用此身份验证类型。 使用此身份验证类型会对您的应用程序施加限制。 例如，使用此流程的应用程序将无法登录需要执行多重身份验证（条件访问）的用户。 它也不会使您的应用程序受益于单点登录。

如果选择此选项，则“ 用户 名” 和“ 密码 ” 属性是必需的，而“ 租户 ” 属性对于单租户应用程序是可选的（对于多租户应用程序是必需的）。

注意：选择用户名和密码身份验证类型时，应用程序ID 属性为必填项。 您可以使用个人帐户、工作帐户和/或学校帐户注册 Microsoft 365 应用程序。

应用程序 ID 和密码

在使用应用程序（客户端）ID 和应用程序（客户端）密码进行身份验证时，请记住以下几点：

• 必须为 Azure 应用程序配置适当的 API 权限，以便 Microsoft 365 活动正常工作（例如，在使用“组”活动时，应为 Microsoft Graph 配置应用程序权限Group.Create 、 Group.Read.All和Group.ReadWrite.All ）。
• 某些活动不能与此类型的身份验证一起使用，因为相应的 Microsoft Graph API 不支持应用程序权限。 请参阅Microsoft 官方文档。
• 对于电子邮件活动（ “获取邮件”、“ 转发邮件”、“ 发送邮件”和“ 移动电子邮件 ”），必须为“ 帐户 ”参数指定一个值。

应用程序 ID 和证书

要使用证书作为密码进行身份验证，请按照以下步骤操作：

1. 在 Azure 门户中：

   • 找到已注册的 Microsoft 365 应用程序。
   • 选择 “证书和 密码”，然后上传您的证书（公钥）文件。 它可以具有以下文件类型之一： .cer、 .pem、 .crt。
     
     

     

     
     
2. 将表示证书的.pfx文件的原始内容转换为base64 string 。 为此，请使用Base64.Grus等基于网页的工具，或将Convert.ToBase64String(System.IO.File.ReadAllBytes(pfxFilePath))赋值给String变量。
3. 在 Microsoft 365 作用域活动中：

• 将“身份验证类型”设置为“应用程序 ID 和证书”。
• 将 CertificateAsBase64 设置为证书的 base64 表示形式。

• 如果需要密码才能使用证书，请同时设置“证书密码” 属性的值。

  注意：与“应用程序 ID 和密码”部分相同的说明也适用于“应用程序 ID”和“证书”。

故障排除

如果遇到任何身份验证问题，请参阅 “ 故障排除 - 身份验证”。