IBM Cloud Docs
Secrets Manager API 变更日志

Secrets Manager API 变更日志

在此更改日志中,您可以了解 IBM Cloud® Secrets Manager API 的最新更改,改进和更新。 更新日志按发布日期顺序列出了所做的更改。 对现有 API 版本的更改旨在与现有客户机应用程序兼容。

要了解 Secrets Manager 服务的常规更新和改进,请参阅 发行说明

2025年2月17日

  • 新增了 managed_csr 字段,用于支持带有企业社会责任管理功能的进口认证。

2024 年 10 月 7 日

  • 现在有了新的配置 action_type,即 private_cert_configuration_action_rotate_intermediate,可以轮换中间 CA 的证书。 了解有关 轮换中级 CA 的 更多信息。

2024 年 9 月 23 日

  • Create Secret API 现在支持通过在新的 account_id 字段中传递帐户 ID 来创建 IAM 秘密,以便在不同的 IBM Cloud 帐户上管理凭证。
  • IAM 凭据配置中新增了 disabled 属性。 使用此属性可在切换到使用 IAM 服务授权配置时禁用 API 密钥配置。
  • Update configuration 方法现在可用于更新 api_key 字段或 disabled 字段。
  • 当管理的服务 ID 属于不同的 IBM Cloud 账户时,将返回一个新字段 account_id

2024 年 9 月 9 日

  • 现在,expiration_date 字段也会返回秘密版本。

2024 年 8 月 6 日

  • 使用 secret_types 选项列出特定引擎的配置。 支持的值有 iam_credentialspublic_certprivate_cert
  • 新属性 crypto_key 用于提供自己的 HSM。

2024 年 6 月 10 日

  • 更新元数据 API 现在支持 null 用于 expiration_date 字段,从而可以禁用 arbitraryusername_passowrd 私钥类型的到期。

2024 年 3 月 11 日

  • 服务端点 API 现在还会返回为服务实例-提供者-受管或用户提供的 (Key Protect 或 Hyper Protect Crypto Services) 选择的密钥管理服务。
  • 列出私钥 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} 按名称而不是标识获取私钥。 在 访问私钥 中了解更多信息。

2023 年 4 月 17 日

Version 2.0.0 was released on 17 April 2023. 此版本包括以下更新:

  • 您无需再在API URL 中包含 secret_type 来识别一个秘密。
  • 对于每个 Secrets Manager 实例,密钥组名称必须唯一。
  • 资源更新定义为 HTTP 补丁操作。
  • 配置 API 遵循 Secrets Manager API 的模式。config_type 充当 API 鉴别器,类似于 secret_type
  • 配置建模为具有元数据和数据部分的 openAPI 组合,类似于 Secrets Manager 模型。 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 已嵌入到 V 2.0中的元数据 API 中。
  • 用于列出私钥和获取私钥元数据的操作将返回 versions_total 字段。 不包含版本的内容。
  • 可以使用版本 API 中的 currentprevious 别名来引用当前和先前的私钥版本。
  • 截至 2023 年 4 月 17 日,已不推荐使用 IBM Cloud® Secrets Manager API v1 以支持 v2。 如果您仍在积极使用 Secrets Manager API v1,请确保尽快启动升级。 在 2023 年 10 月 31 日,将除去对 Secrets Manager API v1 的支持。

2022 年 9 月 12 日

此版本包括以下更新:

2022 年 7 月 10 日

此版本包括以下更新:

2022 年 4 月 25 日

此版本包括以下更新:

  • 添加了可用于通过服务生成 TLS 证书的 private_cert 私钥类型。 有关更多信息,请参阅 创建专用证书
  • 添加了可用于撤销专用证书版本的 对私钥版本调用操作 方法。 目前,此 API 仅支持 private_cert 私钥。
  • 更新了对私钥方法调用操作以将 revoke 包括为受支持的操作。 目前,仅 private_cert 私钥支持 revoke 操作。
  • 更新了可用于检索私钥先前版本的 获取私钥版本 方法。 现在,除了 imported_certpublic_cert 之外,此 API 还支持 private_cert 私钥。
  • 更新了 添加配置列出配置更新配置获取配置除去配置 方法。 现在,除了 public_cert 之外,这些 API 还支持 private_cert 私钥。
  • 添加了用于对特定配置元素 (例如,根或中间认证中心) 运行操作的 对配置调用操作 方法。 目前,此 API 仅支持 private_cert 私钥。

3 2022 年 2 月

此版本包括以下更新:

2022 年 1 月 31 日

此版本包括以下更新:

  • 已将 kv 作为私钥类型添加到 创建私钥 方法。 您可以存储和管理密钥值私钥 (包括复杂 JSON 文档),这些私钥用于访问 IBM Cloud内部或外部的受保护系统。

2021 年 11 月 22 日

此版本包括以下更新:

  • 已将 service_id 字符串参数作为请求主体选项添加到 创建私钥 方法。 您可以使用此字段从帐户创建具有现有服务标识的 IAM 凭证,以便在读取或访问私钥时仅生成 API 密钥。
  • 已将 api_key_id 字符串参数添加到 创建私钥获取私钥元数据 方法的响应详细信息。
  • 已将 service_id_is_static 布尔参数添加到 创建私钥获取私钥元数据 方法的响应详细信息。 此参数指示是否使用现有服务标识创建了 IAM 凭证密钥。
  • 添加了可用于获取私钥版本历史记录信息的 列出私钥版本 方法。
  • 获取私钥获取私钥版本元数据列出私钥版本 方法的响应详细信息添加了 payload_availabledownloaded 布尔参数。 这些参数可帮助您确定是否可以复原私钥版本,以及先前是否已读取或访问该私钥版本。
  • 在对私钥方法调用操作时添加了 restore 查询参数作为请求选项。 您可以使用此操作来 复原先前版本 的私钥。
  • 更新了可用于检索私钥先前版本的 获取私钥版本 方法。 现在,除了 public_certimported_cert 之外,此 API 还支持 arbitraryiam_credentialsusername_password 私钥。

2021 年 9 月 20 日

此版本包括以下更新:

  • 添加了可用于向服务订购域验证的 TLS 证书的 public_cert 私钥类型。 有关更多信息,请参阅 订购证书
  • 添加了可用于向服务添加引擎配置的 添加配置列出配置更新配置获取配置除去配置 方法。 目前,这些 API 仅支持 public_cert 私钥。
  • 更新了可用于检索私钥先前版本的 获取私钥版本 方法。 除 imported_cert 外,此 API 现在还支持 public_cert 私钥。

2021 年 7 月 11 日

此版本包括以下更新:

  • 已将私钥名称的最大长度更改为 240 个字符。
  • 已将私钥描述的最大长度更改为 1024 个字符。

2021 年 6 月 20 日

此版本包括以下更新:

  • 添加了可用于在服务中存储 X.509 证书的 imported_cert 私钥类型。 有关更多信息,请参阅 导入证书
  • 添加了可用于检索私钥的先前版本的 获取私钥版本 方法。 目前,此 API 仅支持 imported_cert 私钥。

2021 年 4 月 13 日

此版本包括以下更新:

  • 添加了可用于按私钥组过滤私钥列表的 group={secret_group_ID} 查询参数。

7 2021 年 3 月

此版本包括以下更新:

  • 为 IAM 凭证私钥添加了 reuse_api_key 布尔参数。

2021 年 2 月 10 日

此版本包括以下更新:

  • 添加了可用于过滤包含指定字符串的私钥列表的 search={string} 查询参数。
  • 添加了可用于按指定元数据字段过滤私钥列表的 sort_by={field_name} 查询参数。

2021 年 1 月 25 日

此版本包括以下更新:

  • 已将私钥名称的最大长度更改为 128 个字符。
  • 已将私钥组名的最大长度更改为 62 个字符。