Secrets Manager API 変更ログ

この変更ログからは、IBM Cloud® Secrets Manager API の最新の変更、改善、更新の内容がわかります。この変更ログでは、行われた変更をリリース日付の順にリストしています。既存の API バージョンに対する変更は、既存のクライアント・アプリケーションの互換性が確保されるように設計されています。

Secrets Manager サービスの一般的な更新および改善について詳しくは、リリース・ノートを参照してください。

2025 年 8 月 25 日

シークレットが最後にアクセスされた日時を特定するための新しいフィールド retrieved_at が追加された。

2025年2月17日

マネージドCSR機能でインポートされた証明書をサポートするために、新しいフィールド managed_csr が追加されました。

2024年10月7日

中間認証局証明書のローテーションを可能にする新しいコンフィギュレーション action_type、 private_cert_configuration_action_rotate_intermediate。中級CAのローテーションについてはこちらをご覧ください。

2024年9月23日

Create Secret API は、新しい account_id フィールドにアカウント ID を渡すことで、別の IBM Cloud アカウントで資格情報を管理するための IAM シークレットを作成できるようになりました。
新しいプロパティ disabled がIAM資格情報設定に追加されました。このプロパティを使用して、IAM サービス認可構成の使用に切り替えたときに、API キー構成を無効にします。
Update configuration メソッドを使用して、api_key フィールドまたは disabled フィールドのいずれかを更新できるようになりました。
管理対象のサービスIDが別のIBM Cloudアカウントに属している場合、新しいフィールド account_id が返されます。

9 2024年9月

expiration_date フィールドがシークレットバージョンでも返されるようになりました。

6 2024年8月

特定のエンジンの設定を一覧表示するには、secret_types オプションを使います。サポートされている値は iam_credentials、public_cert、private_cert です。
独自の HSM を提供するための新しいプロパティ crypto_key。

2024 年 6 月 10 日

メタデータの更新 API は、 expiration_date フィールドで null をサポートするようになりました。これにより、 arbitrary シークレット・タイプと username_passowrd シークレット・タイプの有効期限を無効にすることができます。

2024 年 3 月 11 日

サービス・エンドポイント API は、サービス・インスタンス・プロバイダー管理、またはユーザー提供 (Key Protect または Hyper Protect Crypto Services) 用に選択された鍵管理サービスも返すようになりました。
List secrets API は、追加のパラメーターを受け入れるようになりました。 ?secret_types=... はシークレット・タイプでフィルタリングし、 ?match_all_labels=... はラベルまたはラベルの組み合わせでフィルタリングします。

2024 年 2 月 12 日

ユーザー資格情報のシークレット・タイプは、 password フィールドが空のままである場合に、シークレット作成時のランダム・パスワードの生成をサポートするようになりました。さらに、 password_generation_policy フィールドを組み込むことによって、パスワードの長さ、および数字、記号、および大文字を含めるかどうかを制御することができます。詳しくは、ユーザー資格情報の保管を参照してください。
既存の DNS プロバイダー構成の場合、 apikey フィールドに空ストリングを渡すことで、API キーとサービス間の許可を切り替えることができます。注：スイッチング前に、同一の Cloud Internet Services インスタンスに対して、同一または一致するアクセスポリシーを持つサービス間認証が構成されているものと想定しています。

2023 年 9 月 20 日

新しい API エンドポイント /api/v2/secret_groups/{secret_group_name}/secret_types/{secret_type}/secrets/{name} を使用して、ID ではなく名前でシークレットを取得します。詳しくは、秘密のアクセスを参照してください。

2023 年 4 月 17 日

バージョン 2.0.0 は 2023 年 4 月 17 日にリリースされました。このリリースでは、以下の更新が行われています。

APIで秘密を識別するために、 secret_type を URL に含める必要はなくなりました。
シークレット・グループ名は、 Secrets Manager インスタンスごとに固有でなければなりません。
リソースの更新は、 HTTP パッチ操作として定義されます。
構成 API は、 Secrets Manager API のパターンに従います。 config_type は、 secret_type と同様に API 判別プログラムとして機能します。
構成は、 Secrets Manager モデルと同様に、メタデータとデータ・パーツを含む openAPI コンポジットとしてモデル化されます。 IAM 役割と構成 API の間のマッピングは、 Secrets Manager API と同じパターンに従います。例えば、IAM ビューアーは、構成をリストしてそのメタデータを表示できます。
リスト操作は、シークレット、シークレット・バージョン、および構成リソースのメタデータのみを返します。
シークレットをローテートするアクションは、新しいシークレット・バージョンの作成 API ( POST/v2/secrets/{id}/versions) になりました。
シークレット・バージョンを復元するアクションは、 restored_from_version 本体パラメーターを使用した新しいシークレット・バージョンの作成 API になりました。
IAM 資格情報を削除するアクションは、シークレット・バージョン・データの削除 API ( DELETE /v2/secrets/{id}/versions/{version_id}/secret_data) になりました。
ポリシー API は、バージョン 2.0のメタデータ API に組み込まれるようになりました。
シークレットをリストし、シークレット・メタデータを取得するアクションは、 versions_total フィールドを返します。バージョンの内容は含まれません。
現在のバージョンと以前のバージョンのシークレットは、バージョン API の current 別名と previous 別名を使用して参照できます。
2023 年 4 月 17 日現在、 IBM Cloud® Secrets Manager API v1 は非推奨になり、 v2が推奨されています。まだ Secrets Manager API v1を使用して作業を行っている場合は、できるだけ早くアップグレードを開始してください。 2023 年 10 月 31 日に、 Secrets Manager API v1 のサポートが削除されます。

2022 年 9 月 12 日

このリリースでは、以下の更新が行われています。

組織のニーズに関連するバージョンのカスタム・メタデータを保管するために使用できるシークレット・バージョンのメタデータを更新する方法が追加されました。
シークレットの作成、シークレットに対するアクションの呼び出し、シークレット・メタデータの取得、シークレット・バージョン・メタデータの取得、および「シークレット・メタデータの更新」の各メソッドが更新され、 custom_metadata フィールドと version_custom_metadata フィールドが含まれるようになりました。

2022 年 7 月 10 日

このリリースでは、以下の更新が行われています。

インスタンスでシークレットのロックを作成するために使用できる「シークレットのロック」メソッドと「シークレットのバージョンのロック」メソッドが追加されました。詳しくは、シークレットのロックを参照してください。
シークレットまたは特定のシークレット・バージョンのロックを解除するために使用できる「シークレットのアンロック」方式と「シークレットのバージョンのアンロック」方式が追加されました。
「List secret locks」、「List secret version locks」、および「List all secrets and locks」が追加されました。
シークレットのメタデータの一部として locks_total フィールドを返すように、すべてのシークレット操作が更新されました。

2022 年 4 月 25 日

このリリースでは、以下の更新が行われています。

サービスで TLS 証明書を生成するために使用できるprivate_certシークレット・タイプが追加されました。詳しくは、プライベート証明書の作成を参照してください。
プライベート証明書のバージョンを取り消すために使用できるシークレットのバージョンに対するアクションの呼び出しメソッドが追加されました。現在、このAPIはprivate_certシークレットのみをサポートしています。
Invoke an action on a secretメソッドを更新し、サポートされるアクションとして revoke。現在、 revoke アクションは、 private_cert シークレットのみに対応しています。
シークレットのバージョンの取得メソッドが更新され、以前のバージョンのシークレットをリトリーブできるようになりました。この API は、imported_certおよびpublic_certに加えて、private_certシークレットをサポートするようになりました。
構成の追加、構成のリスト、構成の更新、構成の取得、および構成の削除の各メソッドが更新されました。これらの API は、public_certに加えてprivate_certシークレットもサポートするようになりました。
特定の構成エレメント (ルート認証局や中間認証局など) に対して操作を実行するために使用される構成に対するアクションの呼び出しメソッドが追加されました。現在、このAPIはprivate_certシークレットのみをサポートしています。

2022年2月3日

このリリースには、以下の更新が含まれています。

Event Notificationsへの登録、Event Notifications登録詳細の取得、Event Notificationsからの登録解除、およびEvent Notificationsサービスへの接続を管理するために使用できるテスト・イベントの送信という各メソッドが追加されました。

2022年1月31日

このリリースには、以下の更新が含まれています。

シークレットの作成メソッドにシークレット・タイプとしてkvが追加されました。 IBM Cloudの内部または外部にある保護システムにアクセスするために使用されるキー値シークレット（複雑なJSONドキュメントを含む）を保管および管理できます。

2021 年 11 月 22 日

このリリースでは、以下の更新が行われています。

シークレットの作成メソッドに、リクエストボディオプションとしてservice_idストリング・パラメーターが追加されました。このフィールドを使用すると、アカウントからの既存のサービス ID に IAM 資格情報を作成できます。これにより、シークレットが読み取りまたはアクセスされる際に API キーのみが生成されます。
シークレットの作成メソッドおよびシークレットメタデータの取得メソッドの応答詳細にapi_key_idストリング・パラメーターが追加されました。
シークレットの作成メソッドおよびシークレットメタデータの取得メソッドの応答詳細にservice_id_is_staticブール・パラメーターが追加されました。このパラメーターは、既存のサービス IDを使用して IAM 資格情報シークレットを作成したかどうかを示します。
シークレットのバージョン・ヒストリー情報の取得に使用するために、シークレットのバージョンの一覧表示メソッドが追加されました。
シークレットの取得、シークレット・バージョン・メタデータの取得、シークレットのバージョンリストメソッドの応答の詳細に、payload_availableおよびdownloadedのブール・パラメーターが追加されました。これらのパラメーターは、シークレット・バージョンをリストアできるかどうか、および以前に読み取りまたはアクセスがあったかどうかを識別するのに便利です。
シークレットメソッドでアクションを実行する際のリクエストオプションとして、 restore クエリパラメータを追加しました。このアクションを使用して、シークレットの前のバージョンを復元できます。
シークレットのバージョンの取得メソッドが更新され、以前のバージョンのシークレットをリトリーブできるようになりました。このAPIは、public_certおよびimported_certに加えて、arbitrary、iam_credentials、およびusername_passwordの各シークレットをサポートするようになりました。

2021 年 9 月 20 日

このリリースでは、以下の更新が行われています。

サービスでドメイン検証済みのTLS証明書を注文するために使用できるpublic_certシークレット・タイプが追加されました。詳細については、証明書のオーダーを参照してください。
構成の追加、構成の一覧表示、構成の更新、構成の取得、構成の削除の各メソッドが追加され、サービスにエンジン構成を追加できるようになりました。現在、これらのAPIはpublic_certシークレットのみをサポートしています。
シークレットのバージョンの取得メソッドが更新され、以前のバージョンのシークレットをリトリーブできるようになりました。このAPIは、imported_certに加えてpublic_certシークレットもサポートするようになりました。

2021 年 7 月 11 日

このリリースでは、以下の更新が行われています。

シークレット名の最大長が 240 文字に変更されました。
シークレットの説明の最大長が 1024 文字に変更されました。

2021 年 6 月 20 日

このリリースでは、以下の更新が行われています。

X.509証明書をサービスに格納するために使用できるimported_certシークレット・タイプが追加されました。詳しくは、証明書のインポートをご覧ください。
シークレットのバージョンの取得メソッドが追加され、以前のバージョンのシークレットをリトリーブできるようになりました。現在、このAPIはimported_certシークレットのみをサポートしています。

2021 年 4 月 13 日

このリリースでは、以下の更新が行われています。

シークレット・グループによってシークレット・リストをフィルタリングするために使用できるgroup={secret_group_ID} クエリパラメーターが追加されました。

2021 年 3 月 7 日

このリリースでは、以下の更新が行われています。

IAM資格情報シークレットのreuse_api_keyブール・パラメーターが追加されました。

2021 年 2 月 10 日

このリリースでは、以下の更新が行われています。

指定されたストリングを含むシークレット・リストをフィルタリングするために使用できるsearch={string}クエリパラメーターが追加されました。
指定されたメタデータ・フィールドによってシークレット・リストをフィルタリングするために使用できるsort_by={field_name}クエリパラメーターが追加されました。

2021 年 1 月 25 日

このリリースでは、以下の更新が行われています。

シークレット名の最大長が 128 文字に変更されました。
シークレット・グループ名の最大長が 62 文字に変更されました。