通知を受け取る

UiPath Test Suite

UiPath Test Suite

Integrating your tool with Test Manager

概要


このトピックで説明する承認方法では、Test Manager とユーザーのアプリケーションまたは他のパートナー アプリケーションとの間にサービス間接続を確立する方法についての情報を提供します。

前提条件


Authorization methods


外部 OAuth クライアントをプロビジョニングする方法を、UiPath 製品インフラストラクチャで使用されている各種のバージョンに依存する特定のユース ケースに基づいて、以下の 2 種類から選択できます。

ID 管理を使用したプロビジョニング


[ID 管理] でアプリケーションを登録し、Test Manager のスコープを定義して、アプリケーション間の接続を確立できます。

To configure and authorize your application, you need to add an external application.

When you define the API scopes for the integration, select Test Manager as a Resource. For more information, see Scopes.

Test Manager CLI を使用したプロビジョニング


Test Manager CLI 認可を使用することで、クライアントをプロビジョニングし、スコープを割り当てて、アプリケーション間でサービス間接続を確立できます。

To integrate and start using your application with Test Manager, you need to configure authorization: Provision client and scopes and then get a client ID and client secret.

Configure authorization

To establish a service-to-service connection between Test Manager and your application, you will be using the Test Manager Provisioning Tool as the main CLI tool to get a client, provide access rights and scopes for your integration. You can find this tool packaged with each build as testmanager.exe in the default installation location, as follows:
C:\Program Files (x86)\UiPath\TestManager\Tools\TestManagerProvisioner です。
Alternatively, you can find the executable in your custom installation folder. For a list of commands and options that are outside the scope of your integration, see Test Manager Provisioning Tool Cheat Sheet.

The following section lists the available command-line parameters, including options and default values, so you can provision access rights and scopes, and then get a client ID and client secret for your application.

📘

コマンド オプション 説明

register third-party-s2sclient

-iu, --identityUrl(必須)

Identity Server が置かれている絶対 URL。

-iit, --identityInstallationToken <identityinstallationtoken> (必須)

Identity Server でクライアントをプロビジョニングするための認証トークン。

cscopes, --clientScopes <clientscopes> (必須)

クライアントの作成時に使用されるクライアント スコープを示します。

-cid--clientID

<clientid>

クライアントの作成時に使用されるクライアント ID を示します。クライアント ID を指定しない場合は自動的に生成されます。

-cname, --clientName <clientname>

クライアントの作成時に使用されるクライアント名を示します。クライアント名を指定しない場合は自動的に生成されます。

-csecret, --clientSecret <clientsecret>

クライアントの作成時に使用されるクライアント シークレットを示します。クライアント シークレットを指定しない場合は自動的に生成されます。

-lang, --language <language> エラー メッセージの言語を指定します。
-?-h?--help ヘルプや使用状況に関する情報を表示します。

Shell script sample

以下の例では、register third-party-s2sclient コマンドにつづいて、 Orchestrator Identity URL、ID インストール トークン、Test Manager プロジェクト スコープが記述されています。

testmanager.exe `
register third-party-s2sclient`
-iu "https://orchestratorURL/identity" `
-iit "e908741iofjikasjijfapuosf09210-012opjawdfsaodgfsadgu90029183i1jiratjapo" `
-cscopes "TM.Projects" "TM.Requirements.Read"
Client created successfully. Please note the data below right away. You will not be able to retrieve the secret afterwards.
ClientID: TestManager.ThirdPartyClient.36512487-1rfasdf-11451-321535
ClientName: TestManager.ThirdPartyClient.36512487-1rfasdf-11451-321535
ClientSecret: [email protected]!fgdsg53125sfdg12a*gbj9

API examples

Test Manager への API 呼び出しを実行するには、次の例を参考として、Test Manager プロジェクトを取得します。

API call for Identity Management authorization


GET
https://[test-manager-URL.com]/api/projects

要求

Headers
	Content-Type: application/json
  Authorization: "Bearer [Oauth Access Token]"

レスポンス

Content-Type: application/json
{
  "data": [
    {
      "projectPrefix": "INS",
      "id": "96a80aa7-5a7f-4117-c342-08d7add64671",
      "name": "Insurance Calculator",
      "description": "\"The virtual insurance calculator creates sample quotes for different types of insurance.\"",
"created": "2020-02-10T07:07:33.167Z",
      "createdBy": "74dde091-4a16-4225-aea9-5c3a27b2d996",
      "updated": "2020-02-10T07:07:33.167Z",
      "updatedBy": "74dde091-4a16-4225-aea9-5c3a27b2d996"
    },
    {
      "projectPrefix": "ELI",
      "id": "609f7c5b-c798-46b1-c343-08d7add64671",
      "name": "Eligibility",
      "description": "Eligibility for credit",
      "created": "2020-02-10T09:24:18.63Z",
      "createdBy": "74dde091-4a16-4225-aea9-5c3a27b2d996",
      "updated": "2020-02-10T09:24:18.63Z",
      "updatedBy": "74dde091-4a16-4225-aea9-5c3a27b2d996"
    }
  ],
  "paging": {
    "total": 2,
    "page": 1,
    "pages": 1,
    "pageSize": 12,
    "returned": 2,
    "previousPage": false,
    "nextPage": false
  }
}

API call for Test Manager CLI authorization


GET
https://[test-manager-URL.com]/api/projects

要求

Headers
	Content-Type: application/json
  Authorization: "Bearer [Oauth Access Token]"
	X-UiPath-TenantGlobalId: [Tenant ID]

レスポンス

Content-Type: application/json
{
  "data": [
    {
      "projectPrefix": "INS",
      "id": "96a80aa7-5a7f-4117-c342-08d7add64671",
      "name": "Insurance Calculator",
      "description": "\"The virtual insurance calculator creates sample quotes for different types of insurance.\"",
"created": "2020-02-10T07:07:33.167Z",
      "createdBy": "74dde091-4a16-4225-aea9-5c3a27b2d996",
      "updated": "2020-02-10T07:07:33.167Z",
      "updatedBy": "74dde091-4a16-4225-aea9-5c3a27b2d996"
    },
    {
      "projectPrefix": "ELI",
      "id": "609f7c5b-c798-46b1-c343-08d7add64671",
      "name": "Eligibility",
      "description": "Eligibility for credit",
      "created": "2020-02-10T09:24:18.63Z",
      "createdBy": "74dde091-4a16-4225-aea9-5c3a27b2d996",
      "updated": "2020-02-10T09:24:18.63Z",
      "updatedBy": "74dde091-4a16-4225-aea9-5c3a27b2d996"
    }
  ],
  "paging": {
    "total": 2,
    "page": 1,
    "pages": 1,
    "pageSize": 12,
    "returned": 2,
    "previousPage": false,
    "nextPage": false
  }
}

約 1 か月前に更新


Integrating your tool with Test Manager


改善の提案は、API リファレンスのページでは制限されています

改善を提案できるのは Markdown の本文コンテンツのみであり、API 仕様に行うことはできません。