Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation for capabilities and capabilities-self APIs
- Loading branch information
1 parent
0f82724
commit b5ca8ba
Showing
4 changed files
with
110 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
layout: "http" | ||
page_title: "HTTP API: /sys/capabilities-self" | ||
sidebar_current: "docs-http-auth-capabilities-self" | ||
description: |- | ||
The `/sys/capabilities-self` endpoint is used to fetch the capabilities of client token on a given path. | ||
--- | ||
|
||
# /sys/capabilities-self | ||
|
||
## POST | ||
|
||
<dl> | ||
<dt>Description</dt> | ||
<dd> | ||
Returns the capabilities of client token on the given path. | ||
Client token is the Vault token with which this API call is made. | ||
</dd> | ||
|
||
<dt>Method</dt> | ||
<dd>POST</dd> | ||
|
||
<dt>Parameters</dt> | ||
<dd> | ||
<ul> | ||
<li> | ||
<span class="param">path</span> | ||
<span class="param-flags">required</span> | ||
Path on which the client token's capabilities will be checked. | ||
</li> | ||
</ul> | ||
</dd> | ||
|
||
<dt>Returns</dt> | ||
<dd> | ||
|
||
```javascript | ||
{ | ||
"capabilities": ["read", "list"] | ||
} | ||
``` | ||
|
||
</dd> | ||
</dl> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
--- | ||
layout: "http" | ||
page_title: "HTTP API: /sys/capabilities" | ||
sidebar_current: "docs-http-auth-capabilities" | ||
description: |- | ||
The `/sys/capabilities` endpoint is used to fetch the capabilities of a token on a given path. | ||
--- | ||
|
||
# /sys/capabilities | ||
|
||
## POST | ||
|
||
<dl> | ||
<dt>Description</dt> | ||
<dd> | ||
Returns the capabilities of the token on the given path. | ||
</dd> | ||
|
||
<dt>Method</dt> | ||
<dd>POST</dd> | ||
|
||
<dt>Parameters</dt> | ||
<dd> | ||
<ul> | ||
<li> | ||
<span class="param">token</span> | ||
<span class="param-flags">required</span> | ||
Token for which capabilities are being queried. | ||
</li> | ||
<li> | ||
<span class="param">path</span> | ||
<span class="param-flags">required</span> | ||
Path on which the token's capabilities will be checked. | ||
</li> | ||
</ul> | ||
</dd> | ||
|
||
<dt>Returns</dt> | ||
<dd> | ||
|
||
```javascript | ||
{ | ||
"capabilities": ["read", "list"] | ||
} | ||
``` | ||
|
||
</dd> | ||
</dl> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters