IBM Cloud Docs
编辑密钥模板详细信息

编辑密钥模板详细信息

您可以使用 UI 在 Unified Key Orchestrator 中编辑密钥模板,也可以使用 Unified Key Orchestrator API 以编程方式进行编辑。

使用 UI 编辑密钥模板

要使用 UI 编辑密钥模板的详细信息,请完成以下步骤:

  1. 登录到 Hyper Protect Crypto Services 实例

  2. 单击导航中的 密钥模板 以查看所有可用的密钥模板。

  3. 单击要编辑的密钥模板上的“操作”图标 "操作" 图标,然后选择 显示详细信息

  4. 密钥模板属性下,单击每个卡上的 编辑 以更新属性。 请注意,您可以一次编辑一个属性卡。 要编辑另一个属性卡,请先保存更改。

    1. 您可以更新“常规”属性和“密钥生命周期”属性。 或者,您可以查看密钥命名和密钥材料属性。 以下是您可以编辑的一些属性。

    由于已创建密钥模板,因此无法对使用“锁定”图标标记的密钥命名和密钥材料属性进行更改。

    表 1. 密钥模板属性
    属性 描述
    密钥模板名称 一个独特的、人性化的名称,可轻松识别您的关键模板。 其长度必须为 1–100 个字符。
    描述 (可选) 密钥模板的扩展描述,长度最多为 200 个字符。
    初始密钥状态 要使用密钥模板创建的密钥的状态,包括“预活动”和“活动”。 有关密钥状态的更多信息,请参阅 监视 Unified Key Orchestrator中加密密钥的生命周期
    在以下时间之后激活密钥 (可选) 计划日期以激活自密钥创建以来要创建的预活动密钥。 它仅用于规划目的。
    在以下时间之后取消激活密钥 (可选) 计划日期以取消激活自密钥创建以来要创建的密钥。 它仅用于规划目的。
    1. 密钥库 卡中,单击 编辑 以添加或除去要激活密钥的密钥库。 所有显示的密钥库都属于同一保险库文件和同一密钥库类型:

       - Add keystores
      
       If you want to distribute keys to be created with this template to other keystores, click **Edit** and check the corresponding keystore cards.
      
       - Remove keystores
      
       If you want to unlink keys to be created with this template from some of the keystores, click **Edit** and clear the checkbox in the corresponding keystore cards.
      
       - Create a keystore
      
       If you want to activate keys to be created in a new keystore, click **Add keystore**. For more instructions, see [Creating internal keystores](/docs/hs-crypto?topic=hs-crypto-create-internal-keystores) or [Connecting to external keystores](/docs/hs-crypto?topic=hs-crypto-connect-external-keystores).
      

      如果在进行更改之前已使用此密钥模板创建密钥,那么在密钥的密钥详细信息卡上会显示 Unaligned 标志,指示这些密钥不再与密钥模板同步。 如果要保留这些更改,请忽略该标志。 否则,通过选择 操作 > 与模板重新对齐,再次将密钥与密钥模板重新对齐。 有关更多信息,请参阅 使用密钥模板重新对齐密钥

      如果您连接到类型为 Azure Key Vault 的外部密钥库,那么可以将受 HSM 保护的密钥和受软件保护的密钥都分发到 Azure Key Vault (Premium)。 但是,您只能分发受软件保护的密钥给Azure密钥保管库(标准)。

  5. 完成更改后,单击 保存 以保存更改。

  6. 受管密钥下,查看基于此密钥模板创建的受管密钥总数。 您还可以通过单击要编辑的密钥上的“操作”图标 "操作" 图标 来编辑受管密钥,然后选择 显示详细信息。 有关更多信息,请参阅 编辑密钥详细信息

    要使用搜索栏或根据需要过滤键来搜索特定键,请单击表中的 过滤器 图标 "过滤器" 图标

使用 API 编辑密钥模板

要通过 API 编辑密钥模板详细信息,请执行以下步骤:

  1. 检索服务和认证凭证以使用服务中的密钥模板

  2. 创建密钥模板,方法是 PATCH 调用以下端点。

    https://<instance_ID>.uko.<region>.hs-crypto.appdomain.cloud/api/v4/templates/<id>
    
    

    <id> 替换为密钥模板的标识。

    有关使用 API 方法的详细指示信息和代码示例,请查看 Hyper Protect Crypto Services Unified Key Orchestrator API 参考文档

使用 API 编辑密钥模板的密钥库

要通过 API 编辑现有密钥模板的密钥库,请完成以下步骤:

  1. 检索服务和认证凭证以使用服务中的密钥模板

  2. 通过对以下端点进行 PATCH 调用,将密钥库添加到密钥库组或从密钥库组中除去密钥库。 密钥库组应与与受管密钥相关联的密钥模板匹配。

    https://<instance_ID>.uko.<region>.hs-crypto.appdomain.cloud/api/v4/keystores/<id>
    
    

    代替 <id> 使用您的密钥库的 ID。

  3. 通过对以下端点进行 POST 调用,更新受管密钥以匹配最新版本的关联密钥模板。

    https://<instance_ID>.uko.<region>.hs-crypto.appdomain.cloud/api/v4/managed_keys/<id>/update_from_template
    
    

    <id> 替换为受管密钥的标识。

    有关使用 API 方法的详细指示信息和代码示例,请查看如何在 Hyper Protect Crypto Services Unified Key Orchestrator API 参考文档中 更新内部密钥库或密钥库连接更新受管密钥以匹配密钥模板

下一步