scottk/vault
1
0
Fork 0
mirror of https://github.com/optim-enterprises-bv/vault.git synced 2025-10-30 18:17:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document the managed key PKCS#11 parameter key_id. (#14476)

Browse Source
This commit is contained in:
Victor Rodriguez
2022-03-14 12:08:14 -04:00
committed by GitHub
parent dcb5942bd1
commit 7fa52b8638
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
website/content/api-docs/system/managed-keys.mdx
View File

@@ -90,9 +90,13 @@ $ curl \
- `library` `(string: <required>)` - The name of the `kms_library` stanza to use from Vault's config to - `library` `(string: <required>)` - The name of the `kms_library` stanza to use from Vault's config to
lookup the local library path. See [kms_library stanza](/docs/configuration/kms-library) for further details. lookup the local library path. See [kms_library stanza](/docs/configuration/kms-library) for further details.
- `key_label` `(string: <required>)`: The label of the key to use. If the key - `key_label` `(string: <required>)` - The label of the key to use. If the key does not exist
does not exist and generation is enabled, this is the label that will be given and generation is enabled, this is the label that will be given to the generated key. This
to the generated key. value or `key_id` must be specified.
- `key_id` `(string: <required>)` - The id of a PKCS#11 key to use. As key ids are created by
the HSM, it is an error if the key does not yet exist. This value or `key_label` must be
specified.
- `mechanism` `(string: <required>)` - The encryption/decryption mechanism to use, - `mechanism` `(string: <required>)` - The encryption/decryption mechanism to use,
specified as a hexadecimal (prefixed by 0x) string. The following are supported mechanisms specified as a hexadecimal (prefixed by 0x) string. The following are supported mechanisms