Add documentation for managed key test sign API (#14180)

* Add documentation for managed key test sign API

 - Add the documentation for the new managed key api that allows
   operators to test the managed key configuration by going through
   a sign/verify workflow with some randomly generated data.

* PR feedback
This commit is contained in:
Steven Clark 2022-02-23 09:14:59 -05:00 committed by GitHub
parent eea7fb947a
commit 69bb38450a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 0 deletions

View File

@ -177,6 +177,34 @@ $ curl \
}
```
## Test Sign with a managed key
This endpoint allows an operator to validate that a managed key configuration works
by signing and verifying some randomly generated data. No values can be provided to sign,
nor are signed or verified data returned to the caller. If the call returns a successful HTTP
status code, the configuration can be considered valid.
~> **Note**: if key generation is allowed and no existing key can be found, this call will generate the key
| Method | Path |
|:-------|:------------------------------------------|
| `POST` | `/sys/managed-keys/:type/:name/test/sign` |
### Parameters
- `name` `(string: <required>)` - The lowercase name identifying the key.
- `type` `(string: <required>)` The backend type for the managed key.
### Sample Request
```shell-session
$ curl \
--request POST \
--header "X-Vault-Token: ..." \
http://127.0.0.1:8200/v1/sys/managed-keys/pkcs11/hsm-key1/test/sign
```
## Delete managed key
This endpoint deletes the managed key at the given path provided it is not