- スタート アップ ガイド
- プロジェクト管理
- プロジェクトの運用とユーティリティ
- Test Manager の設定
- ALM ツールとの連携
- API 連携
- ツールを Test Manager と連携する
- スコープ
概要
このトピックで説明する承認方法では、Test Manager とユーザーのアプリケーションまたは他のパートナー アプリケーションとの間にサービス間接続を確立する方法についての情報を提供します。
前提条件
- Orchestrator で Test Automation を有効化します。詳細については、「機能を有効化/無効化する」をご覧ください。
- 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.
認可方法
外部 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 のスコープを定義して、アプリケーション間の接続を確立できます。
アプリケーションを構成して認可するには、外部アプリケーションを追加する必要があります。
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.
認可を設定する
Test Manager とアプリケーションとの間にサービス間接続を確立するには、Test Manager プロビジョニング ツールをメイン CLI ツールとして使用して、クライアントを取得し、連携に必要なアクセス権とスコープを指定します。このツールは、既定のインストール場所で、testmanager.exe として各ビルドに、次のようにパッケージされています。
C:\Program Files (x86)\UiPath\TestManager\Tools\TestManagerProvisioner です。
または、この実行可能ファイルはお使いのカスタム インストール フォルダーにあります。連携のスコープ外のコマンドとオプションのリストについては、「Test Manager プロビジョニング ツール」をご覧ください。
以下のセクションでは、使用可能なコマンドライン パラメーターをオプションおよび既定値と共にリストで示します。これらを使用して、アクセス権やスコープを指定し、アプリケーションのクライアント ID とクライアント シークレットを取得できます。
- 「前提条件」セクションで要求されている、Orchestrator の [ID 管理] で生成されたインストール トークンが必要になります。
- Test Manager のスコープを定義する必要があります。
| コマンド | オプション | 説明 |
|---|---|---|
register third-party-s2sclient | -iu, --identityUrl (必須) | Identity Server が置かれている絶対 URL。 |
-iit, --identityInstallationToken <identityinstallationtoken> (必須) | Identity Server でクライアントをプロビジョニングするための認証トークン。 | |
cscopes, --clientScopes <clientscopes> (必須) | クライアントの作成時に使用されるクライアント スコープを示します。 | |
-cid, --clientID<br /><br /><clientid> | クライアントの作成時に使用されるクライアント ID を示します。クライアント ID を指定しない場合は自動的に生成されます。 | |
-cname, --clientName <clientname> | クライアントの作成時に使用されるクライアント名を示します。クライアント名を指定しない場合は自動的に生成されます。 | |
-csecret, --clientSecret <clientsecret> | クライアントの作成時に使用されるクライアント シークレットを示します。クライアント シークレットを指定しない場合は自動的に生成されます。 | |
-lang, --language <language> | エラー メッセージの言語を指定します。 | |
-?, -h?, --help | ヘルプや使用状況に関する情報を表示します。 |
Shell スクリプトのサンプル
以下の例では、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: 43sdgj@efg145!fgdsg53125sfdg12a*gbj9
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: 43sdgj@efg145!fgdsg53125sfdg12a*gbj9