How to connect to Microsoft 365 activities

概要

Microsoft 365 activities have different authentication flows that you can choose from. Your choice is dependent on: the type of automation mode you plan to run (attended or unattended), the type of projects you want to build (cross-platform or Windows), the type of permissions you want to grant (delegated or app-only), and your application authentication requirements (consult with your administrator if you're unsure which authentication requirements apply to your application).

Use the table below to understand the basic differences between each authentication type:

Microsoft Authentication flow	Microsoft 365 Scope - Authentication type	Integration Service のコネクション	Robot type - Attended	Robot type - Unattended	API permission type
OAuth 2.0 authorization code flow	Interactive Token - public app	OAuth 2.0 の認可コード			委任された権限
	Interactive Token - BYOA	独自の OAuth 2.0 アプリ (BYOA) を使用する			委任された権限
Integrated Windows authentication (IWA)	統合 Windows 認証	N/A			委任された権限
ユーザー名とパスワード	ユーザー名とパスワード	N/A			委任された権限
OAuth 2.0 client credentials flow	Application ID and secret	N/A			アプリケーションの権限
	Application ID and certificate	N/A			アプリケーションの権限

Delegated permissions versus application permissions

To understand the differences between delegated and application permissions, see the Microsoft official documentation: Comparison of delegated and application permissions.

Briefly, the differences are as follows:

• With delegated permissions, the application impersonates a user and acts on the user's behalf. The application can access only what the signed-in user can access.
• With application permissions, the application acts on its own, without a signed-in user. The application can access any data that its permissions are associated with.

For both delegated and application permissions, you can restrict what the application can and can't access using the scopes defined when you create the app. Refer to Scopes and permissions in the Microsoft documentation.

Multitenant versus single-tenant applications

Both Microsoft 365 Scope and Integration Service connections support single tenant applications and multitenant applications. To learn the difference between the two, refer to Who can sign in to you app? in the Microsoft official documentation.

Azure environments

Both Microsoft 365 Scope and Integration Service connections support multiple Azure environments:

• Connections through the Scope activity support: Azure, Azure Global, China, Germany or US Government. The default value is Global.
• Connections through Integration Service support: Default, US Government L4, US Government L5, and China.

Integration Service のコネクション

Integration Service connectors use OAuth 2.0 authorization code flow with delegated permissions.

The Microsoft 365 modern activities and triggers establish an authenticated connection to the Integration Service Microsoft OneDrive & SharePoint and the Microsoft Outlook 365 connectors. To learn more about Integration Service connections, refer to Set up Integration Service connectors.

When you connect to the Microsoft connectors in Integration Service, you have the option to use the standard UiPath public application (with a set of default, non-configurable scopes) or create your own application with Microsoft and customize the scopes you need.

Microsoft 365 Scope connections

The Microsoft 365 Classic activities establish an authenticated connection to your Microsoft 365 applications via the Microsoft 365 Scope activity.

The activities need authorization from the Microsoft identity platform. To enable authorization, you first register your Microsoft 365 application in your Azure Active Directory. When registering your application, you assign Microsoft Graph API permissions to specify the resources your Robot can access on your behalf.

After registering your Microsoft 365 application, Azure Active Directory assigns a unique application (client) ID that you enter in the Microsoft 365 Scope activity. The Application ID is used to collect the necessary information about your registered app to initiate authentication and get the access token to establish the connection.

When you add an activity to Microsoft 365 Scope, its required scopes are automatically detected. You can also choose to allow additional scopes.

対話型トークン

概要

• Runs: as a user.
• Scenario: attended automation.
• Delegated permissions.

注: これは、Integration Service でサポートされている認証方法と同じです。パブリックの UiPath アプリまたはプライベートのカスタム アプリケーション ([独自のアプリを使用する] メソッド) を使用します。

詳細

• When registering your application, you must select an application type. For interactive token authentication, use a mobile/desktop application (which uses OAuth 2.0 authorization code flow).

• 認証の種類の 1 つである [対話型トークン] は、多要素認証 (MFA) が必要な場合に、有人オートメーションで使用できます。これは既定のオプションであり、今回の例で使用します。アクティビティ パッケージに試したい場合、このオプションは設定が容易で、個人アカウントで十分に機能します (セットアップ ガイドの「アプリケーションの登録」セクションのステップ 7 に記載された既定のリダイレクト URI を使用します)。

• You have the option to register and use your own Azure app (i.e., OAuthApplication = Custom) or the one provided by UiPath (OAuthApplication = UiPath).
• When you run the Microsoft 365 activity for the first time using this authentication type, you are prompted to authorize access to the resources (you granted permissions to when registering your app) via a consent dialogue box. See Get access on behalf of a user.

• If you select this authentication type in Microsoft 365 Scope, leave the Username, Password, and Tenant fields empty.

統合 Windows 認証 (IWA)

概要

• Runs: as a user.
• Scenario: unattended automation.
• Delegated permissions.

Note: This authentication type does not work when multi-factor authentication (MFA) is enabled. If your application requires MFA, you can run attended automation using the Interactive Token authentication type or unattended automation using Application ID and Secret and Application ID and Certificate. Application ID and Secret and Application ID and Certificate authentication types are appropriate for unattended automation and work regardless of whether the MFA is enabled or disabled.

詳細

• 認証の種類の 1 つである [統合 Windows 認証] は無人オートメーションに使用できます。このオプションは、Windows ドメインまたは Azure Active Directory に参加しているコンピューター上で実行される Windows がホストするアプリケーションに適用できます。

• When registering your application, you must select an application type. For IWA authentication type, you must use a mobile/desktop application (which uses OAuth 2.0 authorization code flow).

• Works only for federated users and if your registered Azure application is configured to support IWA. Doesn't work for multi-factor authentication (MFA). See details here: IWA on GitHub.
• You should only select this option if your registered application is configured to support Integrated Windows Authentication.

• If you select this authentication type in Microsoft 365 Scope, leave the Username and Password fields empty. The Tenant field is optional.

ユーザー名とパスワード

概要

• Runs: as a user.
• Scenario: unttended automation.
• Delegated permissions.

Note: This authentication type does not work when multi-factor authentication (MFA) is enabled. If your application requires MFA, you can run attended automation using the Interactive Token authentication type or unattended automation using Application ID and Secret and Application ID and Certificate. Application ID and Secret and Application ID and Certificate authentication types are appropriate for unattended automation and work regardless of whether the MFA is enabled or disabled.

詳細

• This authentication type is provided only for legacy reasons. We do not recommend using this option, as it goes against the principles of modern authentication. It doesn't work for multi-factor authentication (MFA). See details here: User & Password on GitHub.

• Microsoft では推奨していませんが、この認証の種類をパブリック クライアント アプリケーションに使用できます。この認証の種類を使用すると、アプリケーションに制約が課されます。たとえば、このフローを使用するアプリケーションには、多要素認証を実行する必要があるユーザーはサインインできません (条件付きアクセス)。また、シングル サインオンのメリットも得られなくなります。
• The ApplicationID property is required when selecting the Username and Password authentication type. You can register your Microsoft 365 Application using your personal, work, and/or school account.

アプリケーション ID とシークレット

概要

• Runs: as background service.
• Scenario: unattended and unattended with MFA enabled.
• Application permissions.
• Recommended for unattended executions or when you want to access the Microsoft Graph API as an application (a background service / daemon) without a signed-in user.

詳細

• When registering your application, you must select an application type. For application ID and secret authentication type, use a confidential/web application (which uses OAuth 2.0 client credentials flow).

• Microsoft 365 アクティビティが正常に動作するには、Azure アプリケーションに対して適切な API アクセス許可を設定する必要があります (たとえば、グループ アクティビティを使用する場合は、Microsoft Graph に対するアプリケーションのアクセス許可 Group.Create、Group.Read.All、Group.ReadWrite.All を設定します)。

• A single organization can have multiple application (client) IDs for their Microsoft 365 account. Each application (client) ID contains its own permissions and authentication requirements. For example, you and your colleague can both register a Microsoft 365 application in your company's Azure Active Directory with different permissions. Your app can be configured to authorize permissions to interact with files only, while your colleague's app is configured to authorize permissions to interact with files, mail, and calendar. If you enter your application (client) ID into this property and run attended automation, the consent dialogue box would be limited to file permissions (and subsequently, only the Files activities can be used).

• Some activities can't be used with this type of authentication because the corresponding Microsoft Graph API does not support application permissions (e.g. Find Meeting Times).

• メール アクティビティの場合は、必ず [アカウント] パラメーターの値 (つまり、テナント内のすべてのメールボックスのどれを使用するか) を指定する必要があります 。

• Use Sites.Selected application permission to allow the application to access just the specific SharePoint site collections rather than all.
• When using this authentication type, the application has access to all mailboxes from your tenant, the reason being that application API permission Mail.Read means Read mail in all mailboxes and Mail.ReadWrite means Read and write mail in all mailboxes. One solution is to restrict Application permissions to specific mailboxes, so the application has access only to the specified mailboxes. For more information, see Scoping application permissions to specific Exchange Online mailboxes.

アプリケーション ID および証明書

概要

• Runs: as background service.
• Scenario: unattended and unattended with MFA enabled.
• Application permissions.

詳細

• When registering your application, you must select an application type. For application ID and certificate authentication type, use a confidential/web application (which uses OAuth 2.0 client credentials flow).

• This authentication mtehod is similar to application ID and secret, but it uses a certificate as a secret instead of a client secret string.

Using certificates

To authenticate using a certificate as a secret, take the following steps:

1. In the the Azure portal:

   • 登録済みの Microsoft 365 アプリケーションを見つけます。
   • [証明書とシークレット] を選択して、証明書 (公開キー) ファイルをアップロードします。.cer、.pem、.crt のいずれかの種類のファイルを使用できます。
     
     

     

     
     
2. Convert the raw contents of your .pfx file representing the certificate to a base64 string. You can use a web-based tool like Base64.Guru or assign the Convert.ToBase64String(System.IO.File.ReadAllBytes(pfxFilePath)) value to a String variable.
3. In the Microsoft 365 Scope activity:

• Set Authentication Type to Application ID and Certificate.
• [Base64 形式の証明書]を Base64 にエンコードされた証明書に設定します。
• 証明書を使用するためにパスワードが必要な場合は、[証明書のパスワード] プロパティの値も設定します。

Integration Service のコネクションなしで Microsoft 365 アクティビティを使用する方法

概要

Integration Service を使用していなくても、[Microsoft 365 スコープ] を使用して、新しい Microsoft 365 アクティビティを使用できるようになりました。

The Microsoft 365 activities designed specifically for Integration Service feature a Connection field, which enables you to choose a connection created through an Integration Service connector. When used inside Microsoft 365 Scope, the activities simply inherit the connection information from the Scope.

認証とプロジェクトの種類のマトリックス

Microsoft 365
	クラウド		オンプレミス
	Microsoft Office 365 アプリケーション スコープ	Integration Service	Microsoft Office 365 アプリケーション スコープ	Integration Service
クロスプラットフォーム
アプリ ID と証明書
アプリ ID とシークレット
OAuth - BYOA
OAuth - UiPath アプリ
ユーザー名とパスワード
統合 Windows 認証
Windows
アプリ ID と証明書
アプリ ID とシークレット
OAuth - BYOA
OAuth - UiPath アプリ
ユーザー名とパスワード
統合 Windows 認証

接続方法

[Microsoft Office 365 スコープ] アクティビティでコネクションを設定する方法は 2 つあります。

接続方法		説明	メリット	デメリット
アセット 注: 推奨。		Orchestrator アセットを使用して、スコープ設定とともにコネクションを保存します。 アセットは、JSON 形式です。 このアクティビティは、使用されるたびにアセットから構成を取得します。 アセットの構成に基づいて、スコープの動作は異なります。認証の種類を識別し、不要なフィールドを非表示にします。 アセットの JSON が正しく設定されていない場合、検証エラーが表示されます。	これらのアクティビティは設計時の検索機能を利用して、ファイル、フォルダー、リスト、範囲などを検出できます。 資格情報はユーザーから別のユーザーにプレーン テキストで渡されないため、コネクションは簡単に転送できます。 管理者が設定できます。 資格情報が Studio のワークフローに届かないため、より安全です。	上級ユーザーがアセットを構成する必要があります。 市民開発者が簡単に設定できるものではありません。
プロパティ パネル		既存の [プロパティ] パネルを使用して、コネクション資格情報を設定します。 構成は、プレーン テキストまたは変数を使用して追加できます。	使いやすさに優れています。 過去のバージョンとの相互運用性を保持します。
	プレーン テキストによる設定 注: 推奨しません。	[プロパティ] パネルをプレーン テキスト値で設定します。	これらのアクティビティは設計時の検索機能を利用して、ファイル、フォルダー、リスト、範囲などを検出できます。	資格情報をプレーン テキスト形式でユーザー間で渡す必要があるため、安全性は低くなります。
	変数を使用した設定	変数を使用して [プロパティ] パネルを設定します。	資格情報が Studio のワークフローに届かないため、より安全です。	アクティビティは、設計時にリソースを検出できません。

Microsoft 365 スコープのアセットの形式

標準アセット形式

{
    "CertificateAsBase64": "",
    "CertificatePassword": "",
    "ClientSecret": "",
    "Environment": "Default" | "Global" | "China" | "Germany" | "USGovernment" | "USGovernmentDOD",
    "Mode": "interactive" | "integrated" | "uap" | "appidsecret" | "appidcertificate",
    "OAuth2AppData": {
        "ApplicationId": "",
        "TenantId": ""
    }
}

UiPath application asset configuration

{
    "CertificateAsBase64": "",
    "CertificatePassword": "",
    "ClientSecret": "",
    "Environment": "Default",
    "Mode": "interactive" | "integrated" | "uap" | "appidsecret" | "appidcertificate",
    "OAuth2AppData": {
        "ApplicationId": "f2f43f65-16a6-4319-91b6-d2a342a88744",
        "TenantId": ""
    }
}

カスタム アプリケーション アセットの構成

注: これは一例に過ぎません。独自のアプリケーションを設定し、必要な OAuth2AppData を取得してください。

{
    "CertificateAsBase64": "",
    "CertificatePassword": "",
    "ClientSecret": "",
    "Environment": "Default",
    "Mode": "interactive" | "integrated" | "uap" | "appidsecret" | "appidcertificate",
    "OAuth2AppData": {
        "ApplicationId": "d47f7253-65ae-58n5-ag04-26109734e6de",
        "TenantId": "3ce4ef03-chb1-871f-94b0-345136965f10"
    }
}

制限事項

[Microsoft 365 スコープ] 内でアクティビティを使用する場合、トリガー、バインド、エクスペリエンスの上書きなどの機能は利用できません。

トークンの更新

Integration Service にあるような、コネクション トークンの更新に使用できるサービスはありません。

If the Authorization Token isn't refreshed for a certain number of days, it expires, and you must re-authenticate. To avoid the expiration of authorization tokens, run a robot with that specific connection. Running an automation with the Scope activity refreshes the authorization token.

追加の OAuth 2.0 リソース:

• 管理者の承認フローあり: Microsoft ID プラットフォームでの OAuth 2.0 クライアント資格情報フロー
• 管理者の承認フローなし: Microsoft ID プラットフォームと OAuth 2.0 承認コード フロー - Microsoft ID プラットフォーム