API キー管理

サイト管理では、OpenText Application Quality Management の API にアクセスする外部アプリケーション用に API キーを作成および管理できます。

このトピックの内容:

API キーの概要

API キー認証は、システムの API にアクセスする外部アプリケーションに安全な認証メカニズムを提供します。

  • 各 API キーには、アプリケーションが認証時に使用するクライアント ID と API キー・シークレットが含まれています。
  • 各 API キーは、システム・ユーザに関連付けられています。そのため、アプリケーションが API キーを使用してシステムにアクセスする場合、アプリケーションは関連付けられたユーザの権限による制限を受けます。
  • システムへのアクセスには、アクティブな API キーのみを使用できます。

  • ユーザを非アクティブ化または削除すると、そのユーザの API キーも削除されます。

拡張機能または API スクリプトを作成するときは、管理者からクライアント ID と API キーを取得して、それらを認証に使用します。REST と OTA を使用する API キー認証の詳細については、開発を参照してください。

先頭に戻る

権限

標準設定では、サイト管理者（オンプレミスの場合）と顧客管理者（SaaS の場合）のみが、［サイト管理］＞［ユーザ］＞［APIキー管理］タブを使用して、ユーザの API キーを作成および管理できます。詳細については、任意のユーザの API キーの作成と管理を参照してください。

サイト管理者または顧客管理者以外のユーザは、APIKEY_SELF_SERVICE_LEVEL パラメータの設定に応じて、［サイト管理］＞［自分の設定］＞［自分のAPIキー］から独自の API キーを作成および管理できます。詳細については、独自の API キーの作成と管理を参照してください。

先頭に戻る

任意のユーザの API キーの作成と管理

サイト管理者または顧客管理者は、アクティブなユーザの API キーの作成、削除、無効化、再生成が可能です。

API キーを作成するには、次の手順を実行します。

  1. ［サイト管理］＞［ユーザ］＞［API キー管理］を開きます。

  2. ［APIキーの追加］をクリックし、次の情報を入力します。

    フィールド 説明
    API キー名 キーの名前を指定します。
    所有者

    キーに関連付けるユーザを選択します。ユーザの権限が、この API キーを使用してシステムにアクセスするすべてのアプリケーションに付与されます。

    SaaS：利用可能なユーザのリストは、現在ログインしている顧客管理者によって異なります。
    有効期間

    API キーが期限切れになるタイミングを指定します。

    この API に設定した有効期間：

    • APIKEY_EXPIRE_DAYS サイト・パラメータによってグローバルに設定された有効期間をオーバーライドします。詳細については、「サイト・パラメータ」を参照してください。

    • APIKEY_EXPIRE_DAYS サイト・パラメータの値以前である必要があります。
    スコープ

    API キーの OData を有効または無効にします。

    API キー認証を使用して OData からプロジェクト・データに接続する場合は、API キーの OData を有効にします。詳細については、拡張レポートのための OData のサポートを参照してください。

  3. ［作成］をクリックし、生成されたクライアント ID と API キー・シークレットを書き留めます。

    生成されたクライアント ID と API キー・シークレットを確実に記録し、関連付けられたユーザに提供します。クライアント ID と API キー・シークレットは、一度生成されると再度取得することはできません。紛失した場合は、キーを無効化して再生成します。

注: 1 ユーザのために作成できる API キーの最大数は、APIKEY_MAX_NUM_PER_USER サイト・パラメータによって制限されています。この制限に達すると、そのユーザの API キーの作成または再生成を行うことはできません。パラメータの詳細については、「サイト・パラメータ」を参照してください。

API キーを削除するには、次の手順を実行します。

リストからキーを選択して［キーの削除］をクリックします。

API キーの所有者が、キーが削除されたことを通知する電子メールを受け取ります。API キーのフル・コントロール権限を持つ基本ユーザの場合、自分の API キーを削除しても通知は届きません。

API キーを無効化するには、次の手順を実行します。

API キーの所有者が API キーを使用してシステムにアクセスすることを一時的にブロックする場合は、API キーを無効化します。

API キーを無効化するには、リストからキーを選択して［キーの無効化］をクリックします。

API キーの所有者が、キーが取り消されたことを通知する電子メールを受け取ります。API キーのフル・コントロール権限を持つ基本ユーザの場合、自分の API キーを取り消しても通知は届きません。

無効化した API キーを再生成するには、次の手順を実行します。

無効化した API キーを再生成できます。これにより、キーが再アクティブ化され、元のクライアント ID で使用する新しい API キー・シークレットが提供されます。

API キーを再生成するには、リストからキーを選択して［キーの再生成］をクリックします。［コピー］ボタンをクリックして、新しい API キー・シークレットを書き留めます。

先頭に戻る

独自の API キーの作成と管理

許可されている場合は、管理者権限なしで独自の API キーの表示、作成、編集が可能です。

前提条件：

基本ユーザが独自の API キーを作成および管理できるかどうかは、APIKEY_SELF_SERVICE_LEVEL パラメータの設定によって異なります。詳細については、APIKEY_SELF_SERVICE_LEVELを参照してください。

独自の API キーを作成し、管理するには、次の手順を実行します。

  1. サイト管理の右上隅で、ログイン・ユーザ・アイコン＞［自分の設定］をクリックします。

  2. ［自分のAPI キー］タブをクリックします。

  3. API キーの詳細を表示するか、アカウントの API キーを作成します。任意のユーザの API キーの作成と管理を参照してください。

先頭に戻る

API キーのフィルタリング

API キー名、ステータス、所有者などのユーザ属性によって API キーをフィルタできます。

API キーをフィルタするには、次の手順を実行します。

  1. ［サイト管理］＞［ユーザ］＞［API キー管理］タブを開きます。

  2. ［フィルタ］をクリックします。

  3. API キーをフィルタする次の属性を指定し、［フィルタ］をクリックします。

    • API キー名：指定した名前の API キーを表示します。

    • クライアント ID：指定したクライアント ID の API キーを表示します。

    • ステータス：指定したステータス（アクティブ、非アクティブ、または無効化済み）の API キーを表示します。

    • 所有者：指定した所有者の API キーを表示します。

    • 作成者：指定した作成者の API キーを表示します。

    • 有効期限：指定された日付までに有効期限が切れる API キーを表示します。

    • 有効期限なし： 有効期限のない API キーを表示します。

先頭に戻る

API キー・サイト・パラメータ

次の表に、API キーに関連するサイト・パラメータを示します。サイト管理者は、これらのパラメータを使用して API キーの動作をサイト・レベルで制御できます。

パラメータ 説明
OTA_ACCESS_APIKEY_ONLY

このパラメータは、サードパーティ・アプリケーションがユーザ名とパスワードを使用して OTA API で認証できるかどうかを制御するために使用します。
RESTAPI_ACCESS_APIKEY_ONLY このパラメータは、アプリケーションがユーザ名とパスワードを使用して REST API で認証できるかどうかを制御するために使用します。
RESTAPI_WHITELIST_APIKEY このパラメータは、ユーザ名とパスワードを使用して REST API でログインできるサードパーティのツールまたはアプリケーションのクライアント・タイプを指定するために使用します。
RESTAPI_DEFAULTLIST_APIKEY このパラメータは、ユーザ名とパスワードを使用して REST API でログインできる内部ツールのクライアント・タイプを指定するために使用します。
APIKEY_MAX_NUM_PER_USER このパラメータは、各ユーザが作成できるアクティブな API キーの最大数を定義します。標準設定値は 10 です。
APIKEY_EXPIRE_DAYS

このパラメータは、すべての API キーの有効期限がグローバルに切れるまでの日数を指定するために使用します。

標準設定値は -1 で、API キーに有効期限はありません。API キーの有効期限が個別に指定されている場合、その API キーについてはこのパラメータはオーバーライドされます。詳細については、有効期間を参照してください。
APIKEY_SELF_SERVICE_LEVEL

このパラメータは、［サイト管理］＞［自分の設定］＞［自分のAPIキー］ページで、すべてのユーザが API キーを使用して実行できる内容を制御するために使用します。

  • admin_only：API キーを作成および管理することはできません。［サイト管理］＞［ユーザ］＞［APIキー管理］から API キーを処理できるのは、サイト管理者または顧客管理者だけです。

  • user_read_only：API キーの作成または編集はできませんが、API キーの詳細を表示することはできます。

  • user_full_control：API キーの作成、表示、無効化、削除、再生成など、API キーを完全に制御できます。

詳細については、「サイト・パラメータ」を参照してください。

先頭に戻る

API キーのトラブルシューティング

次の表に、API キーの使用時に発生する可能性のある問題を示します。

問題 解決策
アップグレード後、既存の API キーを使用して外部アプリケーションに接続できない サイト管理者に連絡して、機密データ・パスフレーズと通信セキュリティ・パスフレーズが以前のバージョンで使用されていたパスフレーズと同じであることを確認してください。バージョン間でパスフレーズが異なると、既存のすべての API キーのシークレットが無効になります。

先頭に戻る