upstream/vault
1
0
Fork 0
mirror of https://github.com/hashicorp/vault.git synced 2026-05-28 04:10:44 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Update website docs to reflect fix in #5495

Browse source
This commit is contained in:
Jeff Mitchell 2018-10-10 11:56:50 -04:00
parent c34cc1e7d7
commit f1f9ed485b
2 changed files with 8 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
website/source/api/system/generate-root.html.md
View file

@ -51,12 +51,7 @@ encode the final root token, it will never be returned.
## Start Root Token Generation
This endpoint initializes a new root generation attempt. Only a single root
generation attempt can take place at a time. One (and only one) of `otp` or
`pgp_key` are required.
Note: `otp` can be empty, in which case an OTP of suitable length will be
generated for you, which is recommended. Future versions of Vault will remove
the need to set this parameter at all.
generation attempt can take place at a time.
| Method | Path | Produces |
| :------- | :--------------------------- | :--------------------- |
@ -64,27 +59,15 @@ the need to set this parameter at all.
### Parameters
- `otp` `(string: <required-unless-pgp>)` – Set, but leave this value blank, to
have Vault generate a suitable OTP and return it.
- `pgp_key` `(string: <required-unless-otp>)` – Specifies a base64-encoded PGP
public key. The raw bytes of the token will be encrypted with this value
before being returned to the final unseal key provider.
### Sample Payload
```json
{
"otp": ""
}
```
- `pgp_key` `(string: <optional>)` – Specifies a base64-encoded PGP public key.
The raw bytes of the token will be encrypted with this value before being
returned to the final unseal key provider.
### Sample Request
```
$ curl \
--request PUT \
--data @payload.json \
http://127.0.0.1:8200/v1/sys/generate-root/attempt
```

25
website/source/api/system/replication-dr.html.md
View file

@ -454,12 +454,7 @@ encode the final token, it will never be returned.
## Start Token Generation
This endpoint initializes a new generation attempt. Only a single
generation attempt can take place at a time. One (and only one) of `otp` or
`pgp_key` are required.
Note: `otp` can be empty, in which case an OTP of suitable length will be
generated for you, which is recommended. Future versions of Vault will remove
the need to set this parameter at all.
generation attempt can take place at a time.
| Method | Path | Produces |
| :------- | :--------------------------- | :--------------------- |
@ -467,27 +462,15 @@ the need to set this parameter at all.
### Parameters
- `otp` `(string: <required-unless-pgp>)` – Set, but leave this value blank, to
have Vault generate a suitable OTP and return it.
- `pgp_key` `(string: <required-unless-otp>)` – Specifies a base64-encoded PGP
public key. The raw bytes of the token will be encrypted with this value
before being returned to the final unseal key provider.
### Sample Payload
```json
{
"otp": ""
}
```
- `pgp_key` `(string: <optional>)` – Specifies a base64-encoded PGP public key.
The raw bytes of the token will be encrypted with this value before being
returned to the final unseal key provider.
### Sample Request
```
$ curl \
--request PUT \
--data @payload.json \
http://127.0.0.1:8200/v1/sys/replication/dr/secondary/generate-operation-token/attempt
```