認証用 API 鍵の生成
API キーを使用すると、スクリプトまたはアプリケーションから IBM Software Hub に対する自動認証を行うことができます。 ユーザーの API 鍵は資格情報に関連付けられており、そのユーザーに固有のものです。 API キーを使用すると、パスワードを入力せずに認証できます。
Get API key エンドポイントを使用して、新しい API キーをプログラムで生成することもできます。 ただし、このエンドポイントには ZenApiKey 許可トークンまたは Bearer トークンが必要であり、推奨されません。
プラットフォーム API キーにより、スクリプトおよびアプリケーションは、通常は IBM Software Hub Web クライアントにログインしたときにアクセスできるすべてのものにアクセスできます。 インスタンス API キーは、そのキーが生成された特定のインスタンスへのアクセスのみを可能にします。
- 必要なアクセス・レベル
- セキュリティーのベスト・プラクティスとして、スクリプトまたはアプリケーションに必要な最小限のアクセス権限を付与することをお勧めします。 例えば、スクリプトが特定のサービス・インスタンスのみと対話する必要がある場合は、そのサービス・インスタンス用の API 鍵を生成します。
- 生成できる鍵のタイプ
- 一部のサービスは、インスタンス・レベルの API 鍵をサポートしていません。 サービスに固有の API 鍵を生成できない場合は、プラットフォーム API 鍵を使用する必要があります。
プラットフォーム API 鍵
プラットフォーム API キーを使用すると、通常は IBM Software Hub Web クライアントにログインしたときにアクセスできるすべてのものにアクセスできます。
プラットフォーム API 鍵を生成するには、以下のようにします。
- Web クライアントにログインします。
- ツールバーから、アバターをクリックします。
- 「プロファイルと設定」をクリックします。
- 「」をクリックします。
- 「生成」をクリックします。
- 「コピー」をクリックし、鍵を安全な場所に保存します。 この鍵は、紛失した場合に復旧することはできません
API 鍵を紛失した場合は、上記のステップを繰り返して、新しい API 鍵を生成します。 古い API 鍵は無効になり、新しい API 鍵が提供されるまで、アプリケーションやスクリプトはプラットフォームに対して認証を行うことができません。
API 鍵が漏洩していると考えられる場合は、以下のようにします。
- Web クライアントにログインします。
- ツールバーから、アバターをクリックします。
- 「プロファイルと設定」をクリックします。
- 「」をクリックします。
- 「取り消し」をクリックします。
この鍵を使用しているすべてのアプリケーションまたはスクリプトが、プラットフォームに対して認証できなくなります。
インスタンス API 鍵
サービスの特定のインスタンスにアクセスできる場合は、そのサービス・インスタンスのみにアクセスするための API 鍵を生成できます。
インスタンス API 鍵を生成するには、以下のようにします。
- Web クライアントにログインします。
- ナビゲーション・メニューから、を選択します。
- API 鍵を生成する対象のインスタンスの名前をクリックします。
- 「」をクリックします。
- 「生成」をクリックします。
- 「コピー」をクリックし、鍵を安全な場所に保存します。 この鍵は、紛失した場合に復旧することはできません
API 鍵を紛失した場合は、上記のステップを繰り返して、新しい API 鍵を生成します。 古い API 鍵は無効になり、新しい API 鍵が提供されるまで、アプリケーションやスクリプトはインスタンスに対して認証を行うことができません。
API 鍵が漏洩していると考えられる場合は、以下のようにします。
- Web クライアントにログインします。
- ナビゲーション・メニューから、を選択します。
- 現在の API 鍵を取り消すインスタンスの名前をクリックします。
- をクリックします。
- 「取り消し」をクリックします。
この鍵を使用しているすべてのアプリケーションまたはスクリプトが、インスタンスに対して認証できなくなります。
API トークン
API 許可トークンを生成するには、以下のいずれかの方法を使用します。