Marketplace ユーザーガイド

最終更新日時 2024年9月5日

認証方法

UiPath Orchestrator API を使用した認証は、接続先の Orchestrator インスタンスの種類に基づいています。Orchestrator インスタンスには Cloud Orchestrator と On-premise Orchestrator の 2 種類があり、どちらもベアラートークンを認証に使用しています。

エンドポイントと入力

認証の観点からすると、インスタンスの種類には主に 2 つの違いがあります。1 つ目は要求の送信先のエンドポイントであり、2 つ目は認証要求に必要な入力です。

以下の表は、2 種類の Orchestrator のそれぞれについて、エンドポイントと入力を示しており、参照可能な API ドキュメントにもリンクしています。

	Cloud Orchestrator	On-premise Orchestrator
エンドポイント	https://account.uipath.com/oauth/token	https://{{orchestrator-url}}/api/Account/Authenticate
入力	アカウントの論理名テナントの論理名クライアント ID ユーザーキーフォルダー (任意)	Orchestrator URL Orchestrator のテナント名メールアドレスまたはユーザー名パスワードフォルダー (任意)
要求/応答	API Swagger Postman	API Swagger Postman

注: Cloud Orchestrator: クライアント ID、ユーザーキー、アカウントの論理名、テナントの論理名の特定方法の詳細については、Orchestrator API のドキュメントの API アクセス情報の取得についての説明をご覧ください。

フォルダー

どちらの種類のインスタンスにも、オプションのフォルダー入力が含まれます。フォルダーを使用すると、オートメーションとその固有のエンティティ、および組織全体の従業員をきめ細かく制御できます。Orchestrator で使用できるフォルダーには、クラシックとモダンの 2 種類があります。クラシックフォルダーは既定で有効化されていますが、モダンフォルダー機能はホストまたはテナント管理者が有効化する必要があります。

ユーザーがフォルダーの値を入力する場合は、フォルダーの OrganizationUnitId を取得する必要があります。認証が完了したら、この ID を後続のすべての API 要求のヘッダーに含める必要があります。

フォルダーの OrganizationUnitId 値の取得方法

OrganizationUnitId を取得するには、フォルダー名を設定し、以下に示す API 要求に従う必要があります。

フォルダー名を入力パラメーターとして使用し、GET 要求を GetFolders エンドポイントに送信します (例: {{base url}}/odata/Folders?$filter=FullyQualifiedName eq '{{FolderName}}')。

ユーザーのユーザー名が既知の場合は、フォルダーの OrganizationUnitId を取得し、その権限を 1 回の要求で検証することもできます。詳しくは、以下をご覧ください。

フォルダーの権限の検証方法

ユーザーが特定のフォルダーにアクセスする権限を持っているかどうかを検証する方法は複数あります。権限の検証方法は、ユーザーがユーザー名 (メールアドレスではない) を持っているかどうかによって異なります。

オプション 1 - 不明なユーザー名

このオプションは Cloud Orchestrator インスタンスに適用され、ユーザーのメールアドレスだけが既知の場合は On-premise Orchestrator インスタンスにも適用されます。

入力された資格情報を使用し、GET 要求を GetCurrentUser エンドポイントに送信することによってユーザーの UserId を取得します (例: {{base url}}/Users/Users_GetCurrentUser)。
UserId を含む GET 応答を取得した後、フォルダー名と UserId を入力パラメーターとして使用して、GET 要求を GetUsersForFolder エンドポイントに送信します (例: {{base url}}/Folders/UiPath.Server.Configuration.OData.GetUsersForFolder(key={{*FolderOrganizationUnitId*}},includeInherited=true)?$filter=Id eq{{userId}})。

オプション 2 - 既知のユーザー名

このオプションは、ユーザー名が既知のインスタンスに適用されます (通常は On-premise Orchestrator インスタンスにのみ適用されます)。

入力されたユーザー名を使用し、GET 要求を GetAllRolesForUserByUsernameAndSkipAndTake エンドポイントに送信します (例: {{base url}}/Folders/UiPath.Server.Configuration.OData.GetAllRolesForUser(username='{{username}}',skip=0,take=0))。
- 応答には、ユーザーがアクセス権限を持つすべてのフォルダーが含まれます。応答を解析することによって、ユーザーが入力したフォルダー名や前の要求で取得された OrganizationUnitId が応答に含まれるかどうかを検証できます。
- このオプションを使用する利点は、フォルダーの OrganizationUnitId を取得して、1 回の要求で権限を検証することができることです。

複数のユーザー

コネクタは、同一または異なる Orchestrator テナントに対して複数の認証されたコネクションを確立できます。複数接続の目的は、実装されたコネクタ機能 (例: ジョブの開始、キューアイテムの追加) に複数のユーザーが Orchestrator の資格情報を共有せずにアクセスして、それらの機能を使用できるようにすることです。