ユーザー API キーの管理
特定の操作には、安全な認可のためにAPIキーが必要です。 操作が円滑に実行されるように、必要に応じてユーザー API キーを生成してローテートすることができます。
ユーザー API キーの概要
プラットフォーム上のサービス内で実行される操作には、認可のためのAPIキーが必要です。 以下の長時間かかるタスクには、有効なAPIキーが必要です
- watsonx.aiランタイムでのモデル学習
- Decision Optimization での問題解決
- パイプライン
- APIキー参照を受け入れるその他のランタイムサービス
スケジュールされたジョブとアドホック・ジョブの両方に、許可のための API キーが必要です。 API キーは、以下の場合にジョブに使用されます。
- 事前定義キーを使用したジョブ・スケジュールの作成
- スケジュール済みジョブの API キーの更新
- アドホック・ジョブの API キーの指定
ユーザー API キーは、資格情報を保護および更新するための制御をアカウント所有者に提供します。これにより、操作を中断することなく実行できるようになります。 キーは、 IBMid およびアカウントに固有です。 作業中のアカウントを変更する場合は、新しい鍵を生成する必要があります。
- 必須ロール
- IAMプラットフォームの役割管理者またはアカウント所有者
アクティブ・キーとフェーズアウト・キー
API キーを作成すると、そのキーは 「アクティブ」 状態になります。 Activeキーは、オペレーションにおける認可に使用される。
鍵をローテートすると、新しい鍵が 「アクティブ」 状態で作成され、既存の鍵が 「フェーズアウト済み」 状態に変更されます。 フェーズアウトされた鍵は許可には使用されず、削除することができます。
現在の API キーの表示
アバターをクリックし、 「プロファイルと設定 (Profile and settings)」 を選択してアカウント・プロファイルを開きます。 「ユーザー API キー (User API key)」 を選択して、 「アクティブ (Active)」 キーと フェーズアウト ・キーを表示します。
API キーの作成
API キーがない場合は、 「キーの作成」をクリックしてキーを作成できます。
新しい鍵が 「アクティブ」 状態で作成されます。 鍵は、セキュアな資格情報を必要とする操作を自動的に許可します。
作業しているプラットフォームが IBM Cloud にデプロイされている場合、キーも IBM Cloud に保存される。 お客様の IBM Cloud アカウントの API キーは、 API keys でご覧いただけます。 AWS では、 IBM SaaS コンソールからAPIキーにアクセスすることはできません。
ユーザー API キーの形式は cpd-apikey- {username} - {timeStamp} です。username はアカウント所有者の IBMid であり、timestamp はキーが作成された日時を示します。
API キーのローテート
サービスの中断を避けるため、APIキーの有効期限が切れる前にAPIキーを交換してください。
API キーが失効または無効になった場合は、すべての操作で使用する新しい アクティブ ・キーを生成できます。
キーを回転させるには、プロフィールの下にあるプロフィールと設定をクリックします。 次に、[User API key]タブをクリックします。 回転をクリックする。
現在の鍵を置き換えるために、新しい鍵が作成されます。 ローテートされた鍵は 「フェーズアウト」 状況になります。 フェーズアウト ・キーは使用できません。
フェーズアウトされた API キーの削除
フェーズアウトされた鍵が操作に必要でなくなったことを確認したら、負符号 (-) をクリックして削除します。 鍵を削除すると、実行中の操作が失敗する可能性があります。
すべての API キーの削除
ごみ箱をクリックして、すべてのキー ( 「アクティブ」 と 「フェーズアウト」の両方) を削除します。 鍵を削除すると、実行中の操作が失敗する可能性があります。
親トピック: アカウントおよびサービスの管理