密钥元数据 API - 用户指南

密钥元数据资源是与密钥关联的附加资源。它允许用户将各种键/值对与密钥关联起来。

如何创建/更新密钥元数据

要创建/更新特定密钥的密钥元数据，我们需要知道要添加用户元数据的密钥的密钥引用。 任何先前设置的元数据都将被删除并替换为此元数据。 有关创建/更新密钥元数据的更多信息，您可以查看 PUT /v1/secrets/{uuid}/metadata 部分。

curl -X PUT -H "content-type:application/json" -H "X-Auth-Token: $TOKEN" \
-d '{ "metadata": {
        "description": "contains the AES key",
        "geolocation": "12.3456, -98.7654"
      }
    }' \
https://:9311/v1/secrets/2a549393-0710-444b-8aa5-84cf0f85ea79/metadata

这应该提供如下响应

{"metadata_ref": "https://:9311/v1/secrets/2a549393-0710-444b-8aa5-84cf0f85ea79/metadata"}

如何检索密钥元数据

要检索单个键/值对的密钥元数据，我们需要知道要查看用户元数据的密钥的密钥引用。 如果某个密钥没有元数据，则将返回一个空的元数据对象。

curl -H "X-Auth-Token: $TOKEN" \
https://:9311/v1/secrets/2a549393-0710-444b-8aa5-84cf0f85ea79/metadata/

这应该提供如下响应

{
    "metadata": {
        "description": "contains the AES key",
        "geolocation": "12.3456, -98.7654"
    }
}

如何创建单个密钥元数据

要创建单个键/值对的密钥元数据，我们需要知道密钥引用。 这将创建一个新的键/值对。 要更新已存在的键，请参阅下面的更新部分。

curl -X POST -H "content-type:application/json" -H "X-Auth-Token: $TOKEN" \
-d '{ "key": "access-limit", "value": "11" }' \
https://:9311/v1/secrets/2a549393-0710-444b-8aa5-84cf0f85ea79/metadata

这应该提供如下响应

Secret Metadata Location: http://example.com:9311/v1/secrets/{uuid}/metadata/access-limit
{
    "key": "access-limit",
    "value": 11
}

如何更新单个密钥元数据

要更新单个键/值对的密钥元数据，我们需要知道密钥引用以及键的名称。

curl -X PUT -H "content-type:application/json" -H "X-Auth-Token: $TOKEN" \
-d '{ "key": "access-limit", "value": "0" }' \
https://:9311/v1/secrets/2a549393-0710-444b-8aa5-84cf0f85ea79/metadata/access-limit

这应该提供如下响应

{
    "key": "access-limit",
    "value": 0
}

如何检索单个密钥元数据

要检索特定键/值对的密钥元数据，我们需要知道密钥引用以及元数据键的名称。

curl -H "X-Auth-Token: $TOKEN" \
https://:9311/v1/secrets/2a549393-0710-444b-8aa5-84cf0f85ea79/metadata/access-limit

这应该提供如下响应

{
    "key": "access-limit",
    "value": 0
}

如何删除单个密钥元数据

要删除单个密钥元数据键/值对，我们需要知道密钥引用以及要删除的元数据键的名称。 要删除密钥的所有元数据，请参阅此页顶部的创建/更新部分。

curl -X DELETE -H "X-Auth-Token: $TOKEN" \
https://:9311/v1/secrets/2a549393-0710-444b-8aa5-84cf0f85ea79/metadata/access-limit

不会提供任何响应。 这是预期行为！ 如果您收到响应，则说明出现问题，您必须在继续之前解决该问题。