このページを共有
APIアクセスのセットアップ
アプリケーションがALM Octaneにアクセスするには、登録済みのアクセスキーをアプリケーションに割り当てる必要があります。アプリケーションは、クライアントとしてALM Octaneと通信する際の認証にこのアクセスキーを使用します。
概要
認証を必要とするアプリケーションには、次のものがあります。
-
ALM Octane CIおよびアプリケーション自動化ツールプラグイン。詳細については、ALM Octane CIプラグインのCIサーバーへのインストールと設定を参照してください。
-
インタラクティブAPIクライアント。
-
ALM Octaneとの統合が必要なその他のサードパーティ製アプリケーションとAPI (ファイアウォールの内側にあるアプリケーションとAPIなど)。
アクセス権を付与する際には、キーが2つ生成されます。
-
クライアントID。
-
クライアントシークレット。シークレットキーは、ユーザーパスワードのようなもので、安全に保管しておく必要があります。
ALM Octaneでは各シークレットを一度しか生成しないため、シークレットキーを後で取得することはできません。新しいシークレットキーが必要な場合は、アクセスキーを取り消してから、アクセスを再生成してください。詳細については、APIアクセスの取り消しおよびAPIアクセスの再生成を参照してください。
注: REST APIを使用したAPIアクセスキーの作成の詳細については、APIアクセスキーの操作 (テクニカルプレビュー)を参照してください。
統合タイプ
アプリケーションにAPIアクセスを提供すると、各アプリケーションに統合タイプが自動的に割り当てられます。標準設定の統合タイプは3rd-party Integrationです。その他の統合タイプは、アプリケーションに割り当てるロールに基づいて割り当てることができます。
APIアクセスが割り当てられたアプリケーションのリストをグリッド表示すると、各アプリケーションの統合タイプを確認できますが、統合タイプを変更することはできません。ここからグリッドにアクセスできます。設定
>スペース > APIアクセス。
注: ほとんどのロールはカスタマイズできます。ロールとその権限は、組織によって異なる場合があります。
| 統合タイプ | 説明 | ロール |
|---|---|---|
| CI/CD統合 |
このタイプでは、JenkinsやTeamCityなどのCI/CDサーバーをALM Octaneと統合できます。 この統合では、共有スペースレベルでALM Octaneと接続します。CI/CD統合ロールが割り当てられているすべてのワークスペースにアクセスできます。 |
CI/CD統合 |
| サードパーティ統合 |
このタイプでは、サードパーティ製アプリケーションをALM Octaneと自由に統合できます。この統合タイプは標準設定として使用できます。また、ロールを定義して、アプリケーションに必要なアクセスを正確に設定できます。 この統合は、任意のワークスペースまたはスペースで機能します。 |
任意のロールの割り当てが可能 |
APIアクセスキーの作成
本項では、APIアクセスキーの作成方法について説明します。
-
設定
>スペースで、スペースを選択します。 -
[APIアクセス] タブで、[+] をクリックします。
-
アクセスの名前を指定します。説明を追加することもできます。
注: APIアクセスキーの名前には、英字のみを使用できます。
-
アプリケーションがALM Octaneへのアクセスに使用するロールを選択します。事前定義されたロールの説明については、事前定義されたロールを参照してください。
注: CIサーバー統合に使用するAPIアクセスキーには、CI/CD統合ロールの割り当てが必要です。これらのキーは、CI統合をサポートするプラグインによって使用されます。また、REST APIを使用してパイプラインを管理する場合に使用されます。
ロールごとに、関連するワークスペースをすべて選択します。後でワークスペースを追加で作成する場合には、手動で割り当てを行う必要があります。
複数のロールを選択するには、[割り当てるロールの追加] をクリックします。
注: ほとんどのロールはカスタマイズできます。ロールとその権限は、組織によって異なる場合があります。
-
追加をクリックします。
-
ダイアログボックスが開き、クライアントIDとクライアントシークレットが表示されます。
[コピー] をクリックしてこれらのキーをクリップボードにコピーすると、ALM Octaneへのアクセスを必要とするアプリケーションを設定する際に使用できます。
[OK] をクリックします。
-
アクセスIDがグリッドに追加されます。ステータスがアクティブ
になっていることを確認します。
-
APIアクセスキーの変更
本項では、APIアクセスキーの変更方法について説明します。
-
設定
>スペースで、スペースを選択します。 -
[APIアクセス] タブで、変更するアクセスを選択します。
-
アクセスの名前と説明を変更できます。
注: APIアクセスキーの名前には、英字のみを使用できます。
このキーセットでロールとアクセス可能なワークスペースのリストも変更可能です。
APIアクセスの取り消し
このセクションでは、APIアクセスキーを取り消す方法について説明します。
-
設定
>スペースで、スペースを選択します。 -
[APIアクセス] タブで、アクセスを取り消す行を選択します。
-
[アクセスの取り消し] をクリックします。アクセスは直ちに取り消され、[アクティブ] カラムには
が表示されます。
アクセスは、必要に応じて再生成することが可能です。APIアクセスの再生成を参照してください。
APIアクセスの再生成
このセクションでは、APIアクセスキーを再生成する方法について説明します。
-
設定
>スペースで、スペースを選択します。 -
[APIアクセス] タブで、取り消したアクセスまたは再生成が必要なアクセスの行を選択します。
-
[アクセスの再生成] をクリックします。
-
ダイアログボックスが開き、選択したクライアントIDの新しく登録されたクライアントシークレットが表示されます。
[コピー] をクリックしてこれらのキーをクリップボードにコピーすると、ALM Octaneへのアクセスを必要とするアプリケーションを設定する際に使用できます。
[OK] をクリックします。
-
アクセスIDがグリッドに追加されます。ステータスがアクティブ
になっていることを確認します。
-
APIアクセス用メールアドレスの設定
APIアクセスキーを使用した統合で電子メールを送信する場合は、この目的で使用する必要のある電子メールアドレスを定義できます。SMTP_NOTIFICATION_SENDER_EMAIL構成パラメーターの値を電子メールアドレスに設定します。詳細については、SMTP_NOTIFICATION_SENDER_EMAILを参照してください。
参照情報:
