このページを共有

# API キーを管理する方法

ALM サイト管理者は、API キー管理ページを使用して API キーを生成および管理できます。このページでは、キーの作成と削除、さらにキーの取り消しや再生成を行うことができます。

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

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

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

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

   標準設定では、API キーは取り消されない限り、期限切れになりません。有効期限を設定するには、`APIKEY_EXPIRE_DAYS` サイト・パラメータを定義します。デフォルト値は「-1」に設定されています。これは、有効期限がないことを意味します。有効期限を設定するには、日数 `N` を設定します。API キーは、指定した日数が経過すると期限切れになります。

   サイト・パラメータを定義するには、「ALM 設定パラメータの指定」を参照してください。

   注: `APIKEY_EXPIRE_DAYS` サイト・パラメータは、作成済みの API キーには影響しません。

2. ［API キー］ウィンドウを開きます。

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

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

   新規 API キーの作成 | ［API アクセス キー］をクリックして、新しいキーを作成します。 キーの［API キー名］と［説明］を入力し、このキーに関連付ける［ユーザ］を指定します。ユーザ権限は、この API キーを使用して認証するすべてのアプリケーションに付与されます。 SaaS: 利用可能なユーザのリストは、現在ログインしている顧客管理者によって異なります。 クライアント ID と API キー シークレットを受け取ります。これらは、このキーを認証に使用する必要があるユーザに提供します。 ヒント: これらは確実に記録してください。このシークレットは再度取得できないからです。紛失した場合は、キーを取り消して再生成し、新しいシークレットを受け取る必要があります。 1 人のユーザのために作成できる API キーの最大数は、`APIKEY_MAX_NUM_PER_USER` サイト・パラメータによって制限されています。この制限に達すると、ユーザの API キーの作成または再生成を行うことはできません。パラメータの詳細については、「ALM サイト・パラメータ」を参照してください。
   キーの削除 | API キー管理ページからクライアント ID を選択します。［キーの削除］をクリックします。 API キーの所有者は、キーが削除されたことを通知する電子メールを受け取ります。API キーのフル・コントロール権限を持つ基本ユーザの場合、自分の API キーを削除しても通知は届きません。
   API キーの取り消し | API キーによる ALM へのアクセスを一時的にブロックする場合は、API キーを取り消します。 API キーを取り消すには、API キー管理ページでクライアント ID を選択し、［キーの無効化］をクリックします。 API キーの所有者は、キーが取り消されたことを通知する電子メールを受け取ります。API キーのフル・コントロール権限を持つ基本ユーザの場合、自分の API キーを取り消しても通知は届きません。
   キーの再生成 | 取り消された API キーを再生成できます。これにより、キーが再アクティブ化され、元のクライアント ID で使用する新しい API キーシークレットが提供されます。 API キー管理ページで、取り消されたクライアント ID を選択します。［キーの再生成］をクリックします。
   更新 | API キー管理ページを更新します。
   有効期限の確認 | ［有効期限］カラムには、API キーがいつ期限切れになるかが表示されます。 API キーが 10 日以内に期限切れになる場合、有効期限の横に次の警告が表示されます。`<N> 日後に期限切れ`。API キーは、有効期限日の深夜 (12:00 a.m.) に期限切れになります。

先頭に戻る

https://admhelp.microfocus.com ALM 8942
検索結果の改善のヒント... ALM ヘルプセンター ALM ヘルプセンター ALM ヘルプ 16.00 すべてローカル・ヘルプセンターの表示オンライン・ヘルプセンターの表示戻るブラウザ履歴で元に戻る進むブラウザ履歴で前に進む検索の強調表示を解除次のトピック次のトピックに移動前のトピック前のトピックに移動現在のトピックを印刷バージョン: