概要

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

前提条件

• Enable Test Automation in Orchestrator. For more information, see Enabling/Disabling Features.
• Generate an installation token in Orchestrator Identity Management. You will need this to provision through the command line. To get the Orchestrator Identity access token, see Generate an installation access token.

Authorization methods

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

• If you run both Test Manager and Orchestrator version 21.4 or above, you can use Provisioning through Identity Management.
• If you run Test Manager version 21.4 and Orchestrator version 20.10, or you want to enable cross-tenant access, you can use the Provisioning through Test Manager CLI.

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.

📘

注

• 「前提条件」セクションで要求されている、Orchestrator の [ID 管理] 内で生成されたインストール トークンが必要になります。
• Test Manager のスコープを定義する必要があります。

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

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

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
  }
}