open-vault/website/content/docs/commands/unwrap.mdx
Jeff Escalante ec620a7765
Implement MDX Remote (#10581)
* implement mdx remote

* fix an unfenced code block

* fix partials path

Co-authored-by: Jim Kalafut <jkalafut@hashicorp.com>
2020-12-17 16:53:33 -05:00

47 lines
1.4 KiB
Plaintext

---
layout: docs
page_title: unwrap - Command
sidebar_title: <code>unwrap</code>
description: |-
The "unwrap" command unwraps a wrapped secret from Vault by the given token.
The result is the same as the "vault read" operation on the non-wrapped
secret. If no token is given, the data in the currently authenticated token is
unwrapped.
---
# unwrap
The `unwrap` command unwraps a wrapped secret from Vault by the given token. The
result is the same as the "vault read" operation on the non-wrapped secret. If
no token is given, the data in the currently authenticated token is unwrapped.
## Examples
Unwrap the data in the cubbyhole secrets engine for a token:
```shell-session
$ vault unwrap 3de9ece1-b347-e143-29b0-dc2dc31caafd
```
Unwrap the data in the active token:
```shell-session
$ vault login 848f9ccf-7176-098c-5e2b-75a0689d41cd
$ vault unwrap # unwraps 848f9ccf...
```
## Usage
The following flags are available in addition to the [standard set of
flags](/docs/commands) included on all commands.
### Output Options
- `-field` `(string: "")` - Print only the field with the given name. Specifying
this option will take precedence over other formatting directives. The result
will not have a trailing newline making it ideal for piping to other processes.
- `-format` `(string: "table")` - Print the output in the given format. Valid
formats are "table", "json", or "yaml". This can also be specified via the
`VAULT_FORMAT` environment variable.