2017-03-15 06:40:33 +00:00
|
|
|
|
---
|
2017-03-17 18:06:03 +00:00
|
|
|
|
layout: "api"
|
2017-03-15 06:40:33 +00:00
|
|
|
|
page_title: "/sys/wrapping/unwrap - HTTP API"
|
2018-10-29 19:58:37 +00:00
|
|
|
|
sidebar_title: "<code>/sys/wrapping/unwrap</code>"
|
New Docs Website (#5535)
* conversion stage 1
* correct image paths
* add sidebar title to frontmatter
* docs/concepts and docs/internals
* configuration docs and multi-level nav corrections
* commands docs, index file corrections, small item nav correction
* secrets converted
* auth
* add enterprise and agent docs
* add extra dividers
* secret section, wip
* correct sidebar nav title in front matter for apu section, start working on api items
* auth and backend, a couple directory structure fixes
* remove old docs
* intro side nav converted
* reset sidebar styles, add hashi-global-styles
* basic styling for nav sidebar
* folder collapse functionality
* patch up border length on last list item
* wip restructure for content component
* taking middleman hacking to the extreme, but its working
* small css fix
* add new mega nav
* fix a small mistake from the rebase
* fix a content resolution issue with middleman
* title a couple missing docs pages
* update deps, remove temporary markup
* community page
* footer to layout, community page css adjustments
* wip downloads page
* deps updated, downloads page ready
* fix community page
* homepage progress
* add components, adjust spacing
* docs and api landing pages
* a bunch of fixes, add docs and api landing pages
* update deps, add deploy scripts
* add readme note
* update deploy command
* overview page, index title
* Update doc fields
Note this still requires the link fields to be populated -- this is solely related to copy on the description fields
* Update api_basic_categories.yml
Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages.
* Add bottom hero, adjust CSS, responsive friendly
* Add mega nav title
* homepage adjustments, asset boosts
* small fixes
* docs page styling fixes
* meganav title
* some category link corrections
* Update API categories page
updated to reflect the second level headings for api categories
* Update docs_detailed_categories.yml
Updated to represent the existing docs structure
* Update docs_detailed_categories.yml
* docs page data fix, extra operator page remove
* api data fix
* fix makefile
* update deps, add product subnav to docs and api landing pages
* Rearrange non-hands-on guides to _docs_
Since there is no place for these on learn.hashicorp, we'll put them
under _docs_.
* WIP Redirects for guides to docs
* content and component updates
* font weight hotfix, redirects
* fix guides and intro sidenavs
* fix some redirects
* small style tweaks
* Redirects to learn and internally to docs
* Remove redirect to `/vault`
* Remove `.html` from destination on redirects
* fix incorrect index redirect
* final touchups
* address feedback from michell for makefile and product downloads
2018-10-19 15:40:11 +00:00
|
|
|
|
sidebar_current: "api-http-system-wrapping-unwrap"
|
2017-03-15 06:40:33 +00:00
|
|
|
|
description: |-
|
|
|
|
|
|
The `/sys/wrapping/unwrap` endpoint unwraps a wrapped response.
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
# `/sys/wrapping/unwrap`
|
|
|
|
|
|
|
|
|
|
|
|
The `/sys/wrapping/unwrap` endpoint unwraps a wrapped response.
|
|
|
|
|
|
|
|
|
|
|
|
## Wrapping Unwrap
|
|
|
|
|
|
|
|
|
|
|
|
This endpoint returns the original response inside the given wrapping token.
|
|
|
|
|
|
Unlike simply reading `cubbyhole/response` (which is deprecated), this endpoint
|
|
|
|
|
|
provides additional validation checks on the token, returns the original value
|
|
|
|
|
|
on the wire rather than a JSON string representation of it, and ensures that the
|
|
|
|
|
|
response is properly audit-logged.
|
|
|
|
|
|
|
|
|
|
|
|
This endpoint can be used by using a wrapping token as the client token in the
|
|
|
|
|
|
API call, in which case the `token` parameter is not required; or, a different
|
|
|
|
|
|
token with permissions to access this endpoint can make the call and pass in the
|
|
|
|
|
|
wrapping token in the `token` parameter. Do _not_ use the wrapping token in both
|
|
|
|
|
|
locations; this will cause the wrapping token to be revoked but the value to be
|
|
|
|
|
|
unable to be looked up, as it will basically be a double-use of the token!
|
|
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
|
|
|
|
|
| `POST` | `/sys/wrapping/unwrap` | `200 application/json` |
|
|
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
|
|
- `token` `(string: "")` – Specifies the wrapping token ID. This is required if
|
|
|
|
|
|
the client token is not the wrapping token. Do not use the wrapping token in
|
|
|
|
|
|
both locations.
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
|
{
|
|
|
|
|
|
"token": "abcd1234..."
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
$ curl \
|
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
|
--request POST \
|
|
|
|
|
|
--data @payload.json \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/wrapping/unwrap
|
2017-03-15 06:40:33 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
|
{
|
|
|
|
|
|
"request_id": "8e33c808-f86c-cff8-f30a-fbb3ac22c4a8",
|
|
|
|
|
|
"lease_id": "",
|
|
|
|
|
|
"lease_duration": 2592000,
|
|
|
|
|
|
"renewable": false,
|
|
|
|
|
|
"data": {
|
|
|
|
|
|
"zip": "zap"
|
|
|
|
|
|
},
|
|
|
|
|
|
"warnings": null
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|