upstream/vault
1
0
Fork 0
mirror of https://github.com/hashicorp/vault.git synced 2026-04-21 14:17:02 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

Update token renew docs (#12572)

Browse source 
* Update docs for token renew api and cli

* Clarify api docs for renew/renew-self

* Update wording around periodic tokens
This commit is contained in:
Pratyoy Mukhopadhyay 2021-09-16 16:54:46 -07:00 committed by GitHub
parent 681a931df4
commit fdd7599551
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
command/token_renew.go
View file

@ -77,10 +77,10 @@ func (c *TokenRenewCommand) Flags() *FlagSets {
Default: 0,
EnvVar: "",
Completion: complete.PredictAnything,
Usage: "Request a specific increment for renewal. Vault is not required " +
"to honor this request. If not supplied, Vault will use the default " +
"TTL. This is specified as a numeric string with suffix like \"30s\" " +
"or \"5m\".",
Usage: "Request a specific increment for renewal. This increment may " +
"not be honored, for instance in the case of periodic tokens. If not " +
"supplied, Vault will use the default TTL. This is specified as a " +
"numeric string with suffix like \"30s\" or \"5m\".",
})
return set

12
website/content/api-docs/auth/token.mdx
View file

@ -337,8 +337,10 @@ if there is a lease associated with it.
- `token` `(string: <required>)` - Token to renew. This can be part of the URL
or the body.
- `increment` `(string: "")` - An optional requested lease increment can be
provided. This increment may be ignored.
- `increment` `(string: "")` - An optional requested increment duration can be
provided. This increment may not be honored, for instance in the case of periodic tokens.
If not supplied, Vault will use the default TTL. This is specified as a numeric string
with suffix like "30s" or "5m".
### Sample Payload
@ -386,8 +388,10 @@ possible only if there is a lease associated with it.
### Parameters
- `increment` `(string: "")` - An optional requested lease increment can be
provided. This increment may be ignored.
- `increment` `(string: "")` - An optional requested increment duration can be
provided. This increment may not be honored, for instance in the case of periodic tokens.
If not supplied, Vault will use the default TTL. This is specified as a numeric string
with suffix like "30s" or "5m".
### Sample Payload

2
website/content/docs/commands/token/renew.mdx
View file

@ -50,6 +50,6 @@ flags](/docs/commands) included on all commands.
### Command Options
- `-increment` `(duration: "")` - Request a specific increment for renewal.
Vault is not required to honor this request. If not supplied, Vault will use
Vault will not honor this request for periodic tokens. If not supplied, Vault will use
the default TTL. This is specified as a numeric string with suffix like "30s"
or "5m". This is aliased as "-i".