Microsoft Office 365 スコープ

UiPath.MicrosoftOffice365.Activities.Office365ApplicationScope

説明

Microsoft ID プラットフォームを使用して、UiPath と Microsoft 365 アプリケーション間の認証されたコネクションを確立します。この認証された接続によって、ロボットは Microsoft Graph API を呼び出し、ユーザーに代わってリソースを読み書きできます。

プロジェクトの対応 OS

Windows - レガシ | Windows

概要

認証されたコネクションするには、まず、Microsoft 365 アプリケーションを Azure Active Directory に登録します (個人、仕事、学校などの Microsoft 365 アカウントを使用)。アプリケーションを登録するときに、Microsoft Graph API アクセス許可を割り当て、ユーザーに代わってロボットがアクセスできるリソースを指定します。

Microsoft 365 アプリケーションを登録すると、Azure Active Directory は一意のアプリケーション (クライアント) ID を割り当てます。この ID を [Microsoft Office 365 スコープ] アクティビティに入力します。アプリケーション ID を使用して登録済みアプリケーションに関する必要な情報を収集し、認証を開始します。

注: アプリケーションの登録とアクセス許可の割り当てに関する詳細は、セットアップ ガイドをご覧ください。このガイドでは、Microsoft 365 アプリケーションを自動化するための設定手順を、ステップバイステップで解説しています。

注: API スコープと権限について詳しくは、「Microsoft 365 および Google Workspace カード - API のアクセス許可とスコープ」をご覧ください。

認証の種類

認証の種類	ユーザーとして	アプリケーションとして (バックグラウンド サービスとして実行)	Attended	Unattended	Unattended (MFA が有効)	詳細
対話型トークン						独自の Azure AD アプリ (OAuthApplication = Custom) または UiPath が提供するアプリ (OAuthApplication = UiPath) を登録して使用できます。
統合 Windows 認証 (IWA)						登録済みの Azure アプリケーションが IWA をサポートするよう設定されている場合、かつフェデレーション ユーザーに対してのみ動作します。 多要素認証 (MFA) では機能しません。 IWA について詳しくは、GitHub のこちらのページをご覧ください。
ユーザー名とパスワード						レガシな方法を使用する理由がある場合以外では推奨されません (モダン認証の原則に反します)。 多要素認証 (MFA) では機能しません。 ユーザーとパスワードの認証について詳しくは、GitHub のこちらのページをご覧ください。
アプリケーション ID とシークレット						無人オートメーションの実行にお勧めです。 または、サインインしているユーザーを使用せず、アプリケーションとして (バックグラウンド サービス/デーモン) Microsoft Graph API にアクセスする場合にお勧めです。
アプリケーション ID および証明書						v1.9.0 以降で利用可能です。アプリケーション ID とシークレットによく似ています。唯一の違いは、シークレットとしてクライアント シークレットの文字列の代わりに証明書を使用する点です。 公式ドキュメントをご覧ください。

プロパティ

アプリケーション ID および証明書 (無人)

• Base64 形式の証明書 - Base64 にエンコードされた証明書です。

  注: [認証の種類] が [ApplicationIdAndCertificate] に設定されている場合、このプロパティは必須です。
• 証明書のパスワード - 証明書を使用する際に必要となる可能性がある、Secure String 型の任意のパスワードです。

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

• アプリケーション シークレット - アプリケーションがその ID を提供するために使用するシークレット文字列です。

• セキュリティで保護されたアプリケーション シークレット - SecureString によるアプリケーション (クライアント) シークレットです。

  注: [認証の種類] が [アプリケーション ID とシークレット] に設定されている場合、これらのいずれかのプロパティが必須です。

認証

重要: Microsoft は Exchange Online の基本認証を廃止します。これは、[Microsoft Office 365 スコープ] などの一部のアクティビティに影響します。このため、OAuth プロトコルをサポートするアクティビティでは OAuth プロトコルを使用することをお勧めします。

• アプリケーション ID - セットアップ時にアプリケーションを登録するときに Azure Active Directory によって割り当てられた一意のアプリケーション (クライアント) ID です。アプリケーション (クライアント) ID は、Microsoft 365 アプリケーションのインスタンスを表します。1 つの組織が、組織の Microsoft 365 アカウントで、複数のアプリケーション (クライアント) ID を持つことができます。各アプリケーション (クライアント) ID には、それぞれ専用のアクセス許可と認証要件が含まれます。たとえば、あるユーザーとその同僚の両方が、会社の Azure Active Directory に異なるアクセス許可で Microsoft 365 アプリケーションを登録できます。そのユーザーのアプリケーションをファイルとの対話の権限のみを認めるように設定し、同僚のアプリケーションをファイル、メール、カレンダーとの対話の権限を認めるように設定することもできます。このプロパティにアプリケーション (クライアント) ID を入力し、有人オートメーションを実行した場合、同意を求めるダイアログ ボックスはファイルのアクセス許可に限定されます (同意後は、ファイル アクティビティのみを使用できます)。
• 認証の種類 - 登録済みアプリケーションに必要な認証の種類です。次の 5 つのオプションから 1 つを選択します: [InteractiveToken]、[IntegratedWindowsAuthentication]、[UsernameAndPassword]、[ApplicationIdAndSecret]、[ApplicationIdAndCertificate]。既定値は、[対話型トークン] です。これらのオプションの詳細、および選択すべきオプションについては、下記の「無人オートメーションと有人オートメーション」のセクションをご覧ください。
• 環境 - 環境です。Azure Global、または Azure Global とは別の独自のナショナル クラウドです。次の 5 つのオプションから 1 つを選択します: [既定]、[Global]、[China]、[Germany]、[USGovernment]。既定値は [Global] です。

• サービス - セットアップ時にアプリケーションを登録するときに API アクセス許可を与えたサービスです。このフィールドでは MicrosoftService 変数のみをサポートします。以下のサービスの中から、いずれか 1 つまたは複数を選択します。

  • Files - 「ファイル」系と「Excel」系のアクティビティの両方、またはいずれか一方を使用する場合は、このサービスを選択します。
  • Mail - 「Outlook」系のアクティビティを使用する場合は、このサービスを選択します。
  • Calendar - 「予定表」系のアクティビティを使用する場合は、このサービスを選択します。
  • Groups - 「グループ」系のアクティビティを使用する場合は、このサービスを選択します。

  • Shared - 「Planner」系のアクティビティを使用する場合は、このサービスを選択します。

    既定値は、未選択です。アプリケーションの登録時に、必要な API アクセス許可が与えられていない場合、このプロパティでサービスを選択しても、それらのアクセス許可を必要とするアクティビティの実行は失敗します。詳細については、「セットアップ」ガイドの「API のアクセス許可を追加する」をご覧ください。

• テナント - セットアップ時にアプリケーションを登録したときに Azure Active Directory によって割り当てられた一意のディレクトリ (テナント) ID です。マルチテナント アプリケーションおよび [統合 Windows 認証] の場合は必須です。ディレクトリ (テナント) ID は登録済みアプリケーションの概要ページ (アプリケーション (クライアント) ID の下) で確認できます。

共通

• エラー発生時に実行を継続 - 設定した場合、現在のアクティビティが失敗しても残りのアクティビティの実行を継続します。
• 表示名 - アクティビティの表示名です。
• タイムアウト (ミリ秒) - 対話型認証 (同意を求めるダイアログ ボックス) が完了するまでの待機時間をミリ秒単位で指定します。この時間を過ぎるとエラーが生成されます。このフィールドでは整数および Int32 型の変数のみがサポートされています。 既定値は、30,000 ms (30 秒) です (表示されません)。

対話型トークン

• OAuth アプリケーション - 使用するアプリケーション (クライアント) を指定します。UiPath を選択した場合、[アプリケーション ID] と [テナント] は無視されます。このフィールドでは OAuthApplication 変数のみサポートされています。次の 2 つのオプションのいずれかを選択します。

  • UiPath - 既定値です。UiPath が作成したアプリケーションを使用する場合。この場合、[アプリケーション ID] と [テナント] パラメーターの値は無視されます。
  • カスタム - 適切な権限を持つ独自のアプリケーションを作成する場合。この場合、[アプリケーション ID] パラメーターに値を設定する必要があります。

その他

• プライベート - オンにした場合、変数および引数の値が Verbose レベルでログに出力されなくなります。

ユーザー名とパスワード (Unattended)

これらのプロパティは、無人オートメーションを実行する場合にのみ適用されます。これらのプロパティに値を指定する場合、[認証の種類] プロパティが [ユーザー名とパスワード] に設定されていることを確認してください。詳細は、上記の「ユーザー名とパスワード」のセクションをご覧ください。

• パスワード ｰ Microsoft 365 アカウントのパスワードです。
• セキュリティで保護されたパスワード ｰ Microsoft 365 アカウントの SecureString によるパスワードです。

• ユーザー名 ｰ Microsoft 365 アカウントのユーザー名です。

  注: [認証の種類] が [ユーザー名とパスワード] の場合は必須です。

動作のしくみ

以下の手順とメッセージ シーケンス図は、設計時 (つまり、アクティビティの依存関係と入/出力プロパティ) から実行時に至るまでの、アクティビティの動作方法の例を示したものです

1. 「セットアップ」の手順を完了します。
2. プロジェクトに [Microsoft Office 365 スコープ] アクティビティを追加します。

3. [認証]、[入力]、[Unattended] (該当する場合) プロパティの値を入力します。

   
   

   

   
   

無人オートメーションと有人オートメーション

[Microsoft Office 365 スコープ] アクティビティには、アクティビティをプロジェクトに追加するときに選択できる 4 種類の認証フロー ([認証の種類]) があります。選択するフローは、実行する自動化モードの種類 (Unattended または Attended) とアプリケーションの認証要件によって異なります (使用するアプリケーションに適用される認証要件が不明の場合は、管理者に問い合わせてください)。

認証の種類	Attended	Unattended	API の権限の種類
対話型トークン	X		委任された権限
統合 Windows 認証		X	委任された権限
ユーザー名とパスワード		X	委任された権限
ApplicationIdAndSecret		X	アプリケーションの権限
ApplicationIdAndCertificate		X	アプリケーションの権限

重要:

多要素認証 (MFA) が有効化されている場合、認証の種類 [統合 Windows 認証] または [ユーザー名とパスワード] は使用できません。

アプリケーションで MFA が必要な場合は、認証の種類 [InteractiveToken] を使用して有人オートメーションを実行するか、[ApplicationIdAndSecret] および [ApplicationIdAndCertificate] を使用して無人オートメーションを実行できます。

認証の種類 [ApplicationIdAndSecret] および [ApplicationIdAndCertificate] は無人オートメーションに適しており、MFA が有効か無効かに関係なく使用できます。

対話型トークン

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

この認証の種類を使用して、はじめて Microsoft 365 アクティビティを実行する場合、同意を求めるダイアログが表示され、リソース (アプリケーション登録時にアクセス許可を与えたもの) へのアクセスを認可するように促されます。

このオプションを選択した場合、[ユーザー名]、[パスワード]、[テナント] プロパティは空のままにする必要があります。

この認証の種類は、OAuth 2.0 認証コード フローに準拠しています。

統合 Windows 認証

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

このオプションは、登録済みアプリケーションが統合 Windows 認証をサポートするように設定されている場合にのみ選択してください (詳細は GitHub 社のサイトをご覧ください)。

このオプションを選択する場合、[ユーザー名] と [パスワード] プロパティは空のままにする必要があります。[テナント] プロパティは任意です。

ユーザー名とパスワード

認証の種類の 1 つである [ユーザー名とパスワード] は無人オートメーションに使用できます。

Microsoft では推奨していませんが、この認証の種類をパブリック クライアント アプリケーションに使用できます。この認証の種類を使用すると、アプリケーションに制約が課されます。たとえば、このフローを使用するアプリケーションには、多要素認証を実行する必要があるユーザーはサインインできません (条件付きアクセス)。また、シングル サインオンのメリットも得られなくなります。

このオプションを選択する場合、[ユーザー名] および [パスワード] プロパティが必須であり、単一テナントのアプリケーションの場合、[テナント] プロパティは任意です (マルチテナント アプリケーションの場合は必須)。

注: [認証の種類] で [ユーザー名とパスワード] を選択する場合は、[アプリケーション ID] プロパティが必須になります。個人、仕事、学校のアカウントで Microsoft 365 アプリケーションを登録できます。

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

アプリケーション (クライアント) ID およびアプリケーション (クライアント) シークレットによる認証に関しては、以下に留意してください。

• Microsoft 365 アクティビティが正常に動作するには、Azure アプリケーションに対して適切な API アクセス許可を設定する必要があります (たとえば、グループ アクティビティを使用する場合は、Microsoft Graph に対するアプリケーションのアクセス許可 Group.Create、Group.Read.All、Group.ReadWrite.All を設定します)。
• 一部のアクティビティではこの認証の種類を使用できません。対応する Microsoft Graph の API がアプリケーションのアクセス許可をサポートしていないからです。詳しくは、こちらの Microsoft 公式ドキュメントをご覧ください。
• メール アクティビティ - [メールを取得]、[メールを転送]、[メールを送信]、[メールを移動] では、[アカウント] パラメーターの値の指定が必須です。

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

証明書をシークレットとして使用して認証するには、以下の手順を実行します。

1. Azure Portal で以下の手順を実行します。

   • 登録済みの Microsoft 365 アプリケーションを見つけます。

   • [証明書とシークレット] を選択して、証明書 (公開キー) ファイルをアップロードします。.cer、.pem、.crt のいずれかの種類のファイルを使用できます。

     
     

     

     
     
2. 証明書を表す .pfx ファイルの未加工コンテンツを、base64 string に変換します。それには、Base64.Guru などの Web ベース ツールを使用するか、Convert.ToBase64String(System.IO.File.ReadAllBytes(pfxFilePath)) を String 変数に割り当てます。
3. [Microsoft Office 365 スコープ] アクティビティで、以下の手順を実行します。

• [認証の種類] を [ApplicationIdAndCertificate] に設定します。
• [Base64 形式の証明書]を Base64 にエンコードされた証明書に設定します。

• 証明書を使用するためにパスワードが必要な場合は、[証明書のパスワード] プロパティの値も設定します。

  注: [アプリケーション ID とシークレット] セクションの記述が [アプリケーション ID と証明書] にも当てはまります。

トラブルシューティング

認証に問題が発生した場合は、「トラブルシューティング」セクションの「認証」をご覧ください。