API アクセス

OAuth 2.0 認可と Integration Service のスコープを使用して、外部アプリケーションから Integration Service API を呼び出す。

概要

Integration Service API を使用すると、選択した外部アプリケーションから Integration Service のリソースを操作できます。OAuth 2.0 フレームワークを使用してアプリケーションを認可するため、サービスやスクリプトはサインインしているユーザー セッションに依存するのではなく、資格情報を共有せずに単独で認証できます。

カスタム コネクタを参照するソリューションをパブリッシュまたはデプロイする CI/CD パイプラインから、またはサインインしているユーザーなしで独自の Integration Service のコネクションを作成または管理する必要があるコード化されたアプリやエージェントから Integration Service を呼び出す場合に使用します。

アクセス権は、付与する範囲に制限されます。外部アプリケーション、または外部アプリケーションを介して動作するユーザーは、これらの権限を超えることはできません。ユーザー トークンを使用した既存の API アクセスに変更はありません。

外部アプリケーションの登録方法について詳しくは、こちらをご覧ください。

API の権限

Integration Service API を呼び出すには、外部アプリケーションに API アクセス許可を付与する必要があります。これらの権限はスコープと呼ばれます。Integration Service をリソースとして追加して、Automation Cloud の [管理] > [外部アプリケーション] に追加する。

スコープ	助成金	として利用可能
です。Connections.Read	コネクションへの読み取りアクセス権です。	ユーザー - スコープ
です。Connectors.Read	コネクタへの読み取りアクセス権 (カスタム コネクタのダウンロードを含む)。	ユーザー スコープ、アプリケーション スコープ
です。Connector.Export	使用されていません。このスコープを必要とするエンドポイントはありません。	N/A

重要:

です。Connections.Read はユーザー スコープ専用です。サインインしているユーザーなしで単独で認証する外部アプリケーションには、権限を付与できません。

非機密アプリケーションには、ユーザー スコープのみを付与できます。アプリケーションの種類、およびユーザーとアプリケーションのスコープの違いについては、「 外部アプリケーションを承認する」をご覧ください。

API 呼び出しを認証する

外部アプリケーションのアクセス トークンを作成して、そのアプリケーションを認可します。アプリケーションの登録時に生成された アプリ ID と アプリ シークレット を使用します。認可方法は、アプリケーションの種類 (機密か非機密か) によって異なります。

外部アプリケーションを 認可する方法 について詳しくは、こちらをご覧ください。

要求のベアラー トークンとしてトークンを送信します。トークンの有効期限は 1 時間です。その後も API の呼び出しを続けるには、新しいアクセス トークンを生成するか、 更新トークンを要求します。

フォルダー スコープ

外部アプリケーションは、 X-UIPATH-FolderKey ヘッダーを使用して、すべての要求で 1 つのフォルダーを対象とする必要があります。また、そのフォルダーに対する Connections.View 権限が必要です。ヘッダーを省略する要求、およびすべてのフォルダーを要求する要求は拒否されます。

ターゲットとしたフォルダーとは異なるフォルダーに存在するコネクションは、禁止としてではなく、「見つかりません」として報告されます。

利用可能なエンドポイント

現在、『API ガイド』には以下のエンドポイントが記載されています。

• コネクションを取得
• ID で接続を取得
• カスタム コネクタをダウンロードする

外部アプリケーションへの応答では、接続の所有者、要素インスタンス ID、ポーリング間隔、および bring-your-own-app フラグが省略されます。接続の設定は、設定の読み取りスコープを保持している呼び出し元にのみ返され、API キーや OAuth トークンなどのシークレット値は返されません。

各エンドポイントについて詳しくは、 『Integration Service API ガイド』をご覧ください。