Update unwrap call documentation
This commit is contained in:
parent
9066f012a7
commit
9d4eedcce4
|
@ -17,7 +17,14 @@ description: |-
|
||||||
simply reading `cubbyhole/response` (which is deprecated), this endpoint
|
simply reading `cubbyhole/response` (which is deprecated), this endpoint
|
||||||
provides additional validation checks on the token, returns the original
|
provides additional validation checks on the token, returns the original
|
||||||
value on the wire rather than a JSON string representation of it, and
|
value on the wire rather than a JSON string representation of it, and
|
||||||
ensures that the response is properly audit-logged.
|
ensures that the response is properly audit-logged.<br/><br/>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!
|
||||||
</dd>
|
</dd>
|
||||||
|
|
||||||
<dt>Method</dt>
|
<dt>Method</dt>
|
||||||
|
@ -31,8 +38,9 @@ description: |-
|
||||||
<ul>
|
<ul>
|
||||||
<li>
|
<li>
|
||||||
<span class="param">token</span>
|
<span class="param">token</span>
|
||||||
<span class="param-flags">required</span>
|
<span class="param-flags">optional</span>
|
||||||
The wrapping token ID.
|
The wrapping token ID; required if the client token is not the wrapping
|
||||||
|
token. Do not use the wrapping token in both locations.
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</dd>
|
</dd>
|
||||||
|
|
Loading…
Reference in a new issue