API キー・アクセスの設定

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

API キー認証の概要

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

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

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

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

先頭に戻る

API キーの使用

ALM サイト管理者は、API キーの作成、削除、取り消し、再生成が可能です。基本ユーザとして、関連付けられている API キーを使用して実行できる内容は、APIKEY_SELF_SERVICE_LEVEL サイト・パラメータの設定によって異なります。パラメータの詳細については、「ALM サイト・パラメータ」を参照してください。

SaaS：API キーを管理する際、オプションは現在ログインしている顧客管理者によって異なります。

  1. （オプション）API キーの有効期限を定義します。

    標準設定では、API キーは取り消されない限り、期限切れになりません。有効期限を設定するには、APIKEY_EXPIRE_DAYS サイト・パラメータを定義します。このパラメータは、既存の API キーには影響しません。

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

  2. Application Lifecycle Management のオプション・ウィンドウで、［API キー］リンクをクリックします。API キーのログイン・ウィンドウで、ユーザ名とパスワードを入力します。

  3. API キーを管理します。

    API キーの作成

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

    1. ［API アクセス］をクリックします。

    2. ［API キー名］フィールドに、キーの名前を入力します。

    3. ［ユーザ］フィールドで、キーに関連付けるユーザを選択します。ユーザの権限が、この API キーを使用して ALM にアクセスするすべてのアプリケーションに付与されます。

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

    4. ［作成］をクリックします。

      クライアント ID と API キー シークレットを受け取ります。これらは、このキーを認証に使用する必要があるユーザに提供します。これらは確実に記録してください。このシークレットは再度取得できないからです。紛失した場合は、キーを取り消して再生成し、新しいシークレットを受け取ります。

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

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

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

    API キーによる ALM へのアクセスを一時的にブロックする場合は、API キーを取り消します。

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

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

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

    API キーを再生成するには、リストからキーを選択して［キーの再生成］をクリックします。
    更新 ［更新］をクリックすると、API キーのリストが更新されます。
    有効期限の確認

    ［有効期限］カラムには、API キーがいつ期限切れになるかが表示されます。

    API キーが 10 日以内に期限切れになる場合、有効期限の横に次の警告が表示されます。<N> 日後に期限切れ。API キーは、有効期限日の深夜（12:00 a.m.）に期限切れになります。

先頭に戻る