プラットフォーム REST API キーの管理

ユーザーアカウントに関連するAPIキーを作成し、API Connectが提供するプラットフォームREST APIを呼び出すときに、そのキーを使って認証します。

このタスクについて

API Connect プラットフォームREST APIを使用するには認証が必要です。 対話式で API を呼び出すには、API キーを生成するためのオプションを指定してツールキット CLI にログインします。 プログラムでAPIを呼び出すには、APIキーを生成し、それをAPI Connectアクセストークンと交換します。 この要件は、API Connectによって提供されるAPIにのみ適用されます。 お客様がインポートまたは作成した API の呼び出しには、API キーは不要です。 APIキーはOIDCユーザー登録タイプでの使用を想定している。
注記：デフォルトでは、APIキーは一度しか使用されないように設定されています ただし、「APIキー設定の構成」のトピックに記載されている手順に従って、構成をカスタマイズし、API寿命を変更することができます

手順

  1. API キーを作成します。
    1. API Connect エンタープライズ・アズ・ア・サービスにログインしてください。
    2. バナーで自分のユーザー名をクリックして、自分のプロファイルを表示します。
    3. プロファイル・ページで、 「マイ API キー」をクリックします。
    4. 「API キー」 ページで、 「追加」をクリックします。
    5. Create API Connect API Key」 フィールドに、キーのタイトルと説明を入力します。 タイトルはユーザーアカウント内で一意でなければなりません。
    6. タイムアウト値を指定するには、「 API key timeout」 フィールドで整数値を選択または入力し、「 Unit」 フィールドで時間の単位（「Seconds」、「Minute」、または「Hours」）を選択します。
      注： デフォルトのタイムアウト値は5分です。
    7. アプリケーションがAPIキーとアクセストークンを複数回交換できるようにするには、「 Enable multiple use 」を選択します。
    8. 「作成」をクリックします。
      注： 説明を入力するまで、「 作成」 ボタンは無効になります。
  2. API キーの管理:
    1. API Connect エンタープライズ・アズ・ア・サービスにログインしてください。
    2. バナーで自分のユーザー名をクリックして、自分のプロファイルを表示します。
    3. プロファイル・ページで、 「マイ API キー」をクリックします。
      ユーザーアカウントに関連付けられているAPIキーのリストが表示されます：
      • キーを表示するには、キーのタイトルと同じ行の API キーの表示 。
      • キーをコピーするには、キーを表示し、 APIキー フィールドで API キーのコピー 。
      • キーを削除するには、キーのタイトルと同じ行で API キーの削除 をクリックし、アクションを確認するプロンプトが表示されたら Delete をクリックします。