Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Token backend documentation inconsistencies #412

Closed
jefferai opened this issue Jul 10, 2015 · 4 comments
Closed

Token backend documentation inconsistencies #412

jefferai opened this issue Jul 10, 2015 · 4 comments
Milestone

Comments

@jefferai
Copy link
Member

I noticed a few inconsistencies today with the Token auth backend:

  1. The docs specify no_parent to create an orphan token, but the help text from the token-create command says that this command is called orphan.

  2. The docs say that if lease is not specified, "the token is valid indefinitely." But this isn't true; it's valid for Vault's hard-coded limit of 30 days. Someone that doesn't carefully look at the returned token_duration and only uses the documentation may get a rude awakening a month down the line.

  3. The docs for auth/token/create indicate that to add metadata to a token you use metadata, but when doing this via the Go API it doesn't work; I need to use meta. However, from the command line client, metadata does work, because it's not converting from JSON like the API.

@sethvargo
Copy link
Contributor

Hey @jefferai

I think the command is functioning as intended and this is actually a docs bug. What do you think?

@sethvargo sethvargo added the bug label Jul 10, 2015
@sethvargo sethvargo added this to the 0.2.0 milestone Jul 10, 2015
@jefferai
Copy link
Member Author

@sethvargo I think these are both documentation bugs, although I haven't checked orphan (it accepts the flag without choking but that doesn't mean it's valid).

@jefferai
Copy link
Member Author

Please note problem number 3 that I just added to the original comment above.

@armon armon closed this as completed in 0cc974b Jul 13, 2015
@armon
Copy link
Member

armon commented Jul 13, 2015

@jefferai Thanks for catching these! The first one is not a "bug" per-se, the CLI tool just is mapping the -orphan flag to the no_parent option. The API is no_parent however.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants