ユーザー API キーの管理

特定の操作には、安全な認可のためにAPIキーが必要です。 必要に応じてユーザーAPIキーを生成し、ローテーションすることで、業務を円滑に進めることができます。

ユーザー API キーの概要

プラットフォーム上のサービス内で実行されるオペレーションは、認可のためにAPIキーを必要とする。 以下の長時間かかるタスクには、有効なAPIキーが必要です

  • watsonx.aiランタイムでのモデル学習

  • Decision Optimization での問題解決

  • パイプライン

  • APIキー参照を受け入れるその他のランタイムサービス

  • データクレンジングとバリデーション Data Refinery

  • DataStage フローによるデータ変換

ジョブの承認にはAPIキーが必要です。 API キーは、以下の場合にジョブに使用されます。

  • 事前定義キーを使用したジョブ・スケジュールの作成
  • スケジュール済みジョブの API キーの更新
  • アドホック・ジョブの API キーの指定

ユーザーAPIキーは、アカウント所有者にクレデンシャルの保護と更新をコントロールさせ、業務が中断することなく実行されるよう支援する。 キーは、 IBMid およびアカウントに固有です。 作業中のアカウントを変更する場合は、新しい鍵を生成する必要があります。

必要な役割
IAMプラットフォームの役割管理者またはアカウント所有者

制限事項

  • 信頼できるプロフィールからログインしている場合、プロフィールの設定によっては、APIキーを生成またはローテーションするオプションがない場合があります。 代わりに、プロファイルの静的メンバーの1人が生成したAPIキーを使用する必要があります。 詳細については、 信頼済みプロファイルの設定の概要を参照してください。

ユーザーAPIキーの一覧へのアクセス

注: この方法では実際のAPIキーを表示することはできません。

APIキーのリストを表示するには

  1. アバターをクリックし、 「プロファイルと設定 (Profile and settings)」 を選択してアカウント・プロファイルを開きます。
  2. ユーザーAPIキーを選択すると、アクティブなキーとフェーズアウトされたキーが表示されます。

ユーザーAPIキーの作成

ユーザーAPIキーを作成するには:

  1. アバターをクリックし、 「プロファイルと設定 (Profile and settings)」 を選択してアカウント・プロファイルを開きます。
  2. ユーザーAPIキーを選択します。
  3. Create a keyをクリックする。

新しい鍵が 「アクティブ」 状態で作成されます。 キーは、安全な認証情報を必要とする操作を自動的に許可します。

注: 新しいユーザーAPIキーは表示できません。 内部利用のみを目的としています。 例えば、ジョブやパイプラインでの使用のために。
注:

作業中のプラットフォームが IBM Cloud にデプロイされている場合、ユーザー API キーも IBM Cloud に保存されます。 あなたの IBM Cloud アカウントのユーザー API キーは、 API keys で見ることができます。 AWS では、 IBM SaaS コンソールからユーザー API キーにアクセスすることはできません。

ユーザーAPIキーのローテーション

重要: AWS のAPIキーは365日ごとに失効します。 管理者がAPIキーを失効させると、サービスが使用するサービスIDはタスクを実行できなくなる。 例えば、データ商品の配送は Data Product Hub では機能しません。 サービスの中断を避けるため、APIキーの有効期限が切れる前にAPIキーを交換してください。

ユーザーAPIキーが期限切れまたは無効になった場合、すべての操作で使用できる新しい有効なキーを生成できます。

キーを回転させる:

  1. アバターをクリックし、 「プロファイルと設定 (Profile and settings)」 を選択してアカウント・プロファイルを開きます。
  2. ユーザーAPIキーを選択すると、アクティブなキーとフェーズアウトされたキーが表示されます。
  3. 回転をクリックする。

鍵をローテートすると、新しい鍵が 「アクティブ」 状態で作成され、既存の鍵が 「フェーズアウト済み」 状態に変更されます。 フェーズアウトされたキーは認可に使用されず、削除することができる。

廃止されたユーザーAPIキーの削除

警告キーを削除すると、実行中のオペレーションが失敗する可能性があります。

廃止されたユーザーAPIキーを削除するには:

  1. アバターをクリックし、 「プロファイルと設定 (Profile and settings)」 を選択してアカウント・プロファイルを開きます。
  2. ユーザーAPIキーを選択すると、アクティブなキーとフェーズアウトされたキーが表示されます。
  3. フェーズアウトしたキーの隣にあるマイナス記号をクリックします。

すべてのユーザーAPIキーを削除する

警告キーを削除すると、実行中のオペレーションが失敗する可能性があります。

すべてのAPIキーを削除するには

  1. アバターをクリックし、 「プロファイルと設定 (Profile and settings)」 を選択してアカウント・プロファイルを開きます。
  2. ユーザーAPIキーを選択すると、アクティブなキーとフェーズアウトされたキーが表示されます。
  3. ゴミ箱アイコンをクリックする。

詳細はこちら: