Secrets Manager API 變更記錄
在此變更日誌中,您可以瞭解 IBM Cloud® Secrets Manager API 的最新變更、改進及更新。 變更記錄會列出已進行的變更,依發佈日期排序。 現有 API 版本的變更設計為與現有用戶端應用程式相容。
若要瞭解 Secrets Manager 服務的一般更新及改進,請參閱 版本注意事項。
2025 年 8 月 25 日
- 新增欄位
retrieved_at,以識別秘密的最後存取時間。
2025 年 2 月 17 日
- 新增欄位
managed_csr,以支援以管理 CSR 匯入的憑證功能。
2024 年 10 月 7 日
- 現在有一個新的設定
action_type,private_cert_configuration_action_rotate_intermediate,可用來啟用中間憑證授權證書的輪換。 了解有關 輪換中間 CA 的 更多資訊。
2024 年 9 月 23 日
- Create Secret API 現在支援建立 IAM 金鑰,透過在新的
account_id欄位中傳遞帳號 ID 來管理不同IBM Cloud帳號上的憑證。 - 新屬性
disabled已新增至 IAM 憑證配置中。 當您切換到使用 IAM 服務授權配置時,使用此屬性可停用 API 金鑰配置。 - 現在可以使用 更新配置 方法來更新
api_key欄位或disabled欄位。 - 當正在管理的服務 ID 屬於不同的IBM Cloud帳戶時,將會傳回新欄位
account_id。
2024 年 9 月 9 日
expiration_date欄位現在也會針對秘密版本傳回。
2024 年 8 月 6 日
- 使用
secret_types列出特定引擎的配置的選項。 支援的值為:iam_credentials,public_cert,和private_cert。 - 新樓盤
crypto_key提供您自己的 HSM。
2024 年 6 月 10 日
- 更新 meta 資料 API 現在支援
expiration_date欄位的null,因此可以停用arbitrary及username_passowrd密鑰類型的有效期限。
2024 年 3 月 11 日
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 日
2023 年 4 月 17 日發行了 2.0.0 版。 此版本包含下列更新:
- 您不再需要在 API URL 中包含
secret_type來識別秘密。 - 每個 Secrets Manager 實例的密鑰群組名稱必須是唯一的。
- 資源更新定義為 HTTP 修補作業。
- 配置 API 遵循 Secrets Manager API 的型樣。
config_type充當 API 鑑別器,類似於secret_type。 - 配置建模為具有 meta 資料和資料組件的 openAPI 組合,類似於 Secrets Manager 模型。 IAM 角色與配置 API 之間的對映遵循 Secrets Manager API 的相同型樣。 例如,IAM 檢視器可以列出配置以檢視其 meta 資料。
- 列出作業只會傳回密鑰、密鑰版本及配置資源的 meta 資料。
- 現在,輪換密鑰的動作是建立新的密鑰版本 API:
POST/v2/secrets/{id}/versions。 - 還原密鑰版本的動作現在是使用
restored_from_version內文參數建立新的密鑰版本 API。 - 刪除 IAM 認證的動作現在是刪除密碼版本資料 API:
DELETE /v2/secrets/{id}/versions/{version_id}/secret_data。 - 現在,原則 API 已內嵌至 2.0版中的 meta 資料 API。
- 用於列出密鑰並取得密鑰 meta 資料的動作會傳回
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 日
此版本包含下列更新:
- 已新增 更新密鑰版本的 meta 資料 方法,可用來儲存與組織需求相關的版本自訂 meta 資料。
- 已更新 建立密鑰、對密鑰呼叫動作、取得密鑰 meta 資料、取得密鑰版本 meta 資料,以及
更新密鑰 meta 資料 方法,以包括
custom_metadata及version_custom_metadata欄位。
2022 年 7 月 10 日
此版本包含下列更新:
2022 年 4 月 25 日
此版本包含下列更新:
- 已新增可用來使用服務產生 TLS 憑證的
private_cert密鑰類型。 如需相關資訊,請參閱 建立專用憑證。 - 已新增 對密鑰版本呼叫動作 方法,可用來撤銷專用憑證版本。 目前,此 API 僅支援
private_cert密碼。 - 已更新對密鑰方法執行的「呼叫」動作,以包括
revoke作為支援的動作。 目前,僅private_cert密鑰支援revoke動作。 - 已更新 取得密鑰的版本 方法,可用來擷取舊版密鑰。 除了
imported_cert和public_cert之外,此 API 現在還支援private_cert密碼。 - 已更新 新增配置、列出配置、更新配置、
取得配置 及 移除配置 方法。 除了
public_cert之外,這些 API 現在還支援private_cert密碼。 - 已新增 對配置呼叫動作 方法,可用來對特定配置元素 (例如主要或中繼憑證管理中心) 執行作業。 目前,此 API 僅支援
private_cert密碼。
2022 年 2 月 3 日
此版本包含以下更新:
- 已新增 登錄 Event Notifications、Get Event Notifications 登錄詳細資料、 從 Event Notifications 及 傳送測試事件 方法,這些方法可用來管理與 Event Notifications 服務的連線。
2022 年 1 月 31 日
此版本包含以下更新:
- 將
kv作為密鑰類型新增至 建立密鑰 方法。 您可以儲存及管理金鑰值密鑰 (包括複式 JSON 文件),這些密鑰用於存取 IBM Cloud內部或外部的受保護系統。
2021 年 11 月 22 日
此版本包含下列更新:
- 將
service_id字串參數作為要求內文選項新增至 建立密鑰 方法。 您可以使用此欄位,使用帳戶中的現有服務 ID 來建立 IAM 認證,以便在讀取或存取密鑰時僅產生 API 金鑰。 - 已將
api_key_id字串參數新增至 建立密鑰 及 取得密鑰 meta 資料 方法的回應詳細資料。 - 已將
service_id_is_static布林參數新增至 建立密鑰 及 取得密鑰 meta 資料 方法的回應詳細資料。 此參數指出是否使用現有服務 ID 建立 IAM 認證密鑰。 - 已新增 列出密鑰的版本 方法,可用來取得密鑰的版本歷程資訊。
- 已將
payload_available及downloaded布林參數新增至 取得密鑰、取得密鑰版本 meta 資料、 列出密鑰版本 方法的回應詳細資料。 這些參數可協助您識別是否可以還原密鑰版本,以及先前是否已讀取或存取該密鑰版本。 - 在對 secret 方法呼叫動作時,已新增
restore查詢參數作為要求選項。 您可以使用此動作來 還原舊版 密鑰。 - 已更新 取得密鑰的版本 方法,可用來擷取舊版密鑰。 除了
public_cert和imported_cert之外,此 API 現在還支援arbitrary、iam_credentials和username_password密鑰。
2021 年 9 月 20 日
此版本包含下列更新:
2021 年 7 月 11 日
此版本包含下列更新:
- 已將密鑰名稱的長度上限變更為 240 個字元。
- 將密鑰說明的長度上限變更為 1024 個字元。
2021 年 6 月 20 日
此版本包含下列更新:
2021 年 4 月 13 日
此版本包含下列更新:
- 已新增
group={secret_group_ID}查詢參數,可用來依密鑰群組過濾密鑰清單。
2021 年 3 月 7 日
此版本包含下列更新:
- 已新增 IAM 認證密碼的
reuse_api_key布林參數。
2021 年 2 月 10 日
此版本包含下列更新:
- 已新增
search={string}查詢參數,可用來過濾包含指定字串的密鑰清單。 - 已新增
sort_by={field_name}查詢參數,可用來依指定的 meta 資料欄位過濾密鑰清單。
2021 年 1 月 25 日
此版本包含下列更新:
- 已將密鑰名稱的長度上限變更為 128 個字元。
- 已將密鑰群組名稱的長度上限變更為 62 個字元。