2017-03-15 06:40:33 +00:00
|
|
|
|
---
|
2020-01-18 00:18:09 +00:00
|
|
|
|
layout: api
|
|
|
|
|
page_title: /sys/capabilities-accessor - HTTP API
|
2017-03-15 06:40:33 +00:00
|
|
|
|
description: |-
|
|
|
|
|
The `/sys/capabilities-accessor` endpoint is used to fetch the capabilities of
|
2018-03-01 16:42:39 +00:00
|
|
|
|
the token associated with an accessor, on the given paths.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# `/sys/capabilities-accessor`
|
|
|
|
|
|
2017-11-03 15:20:10 +00:00
|
|
|
|
The `/sys/capabilities-accessor` endpoint is used to fetch the capabilities of
|
2018-03-01 16:42:39 +00:00
|
|
|
|
the token associated with the given accessor. The capabilities returned will be
|
|
|
|
|
derived from the policies that are on the token, and from the policies to which
|
|
|
|
|
the token is entitled to through the entity and entity's group memberships.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
|
|
|
|
## Query Token Accessor Capabilities
|
|
|
|
|
|
2018-03-01 16:42:39 +00:00
|
|
|
|
This endpoint returns the capabilities of the token associated with the given
|
|
|
|
|
accessor, for the given path. Multiple paths are taken in at once and the
|
|
|
|
|
capabilities of the token associated with the given accessor for each path is
|
|
|
|
|
returned. For backwards compatibility, if a single path is supplied, a
|
|
|
|
|
`capabilities` field will also be returned.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
2020-01-18 00:18:09 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :----- | :--------------------------- |
|
|
|
|
|
| `POST` | `/sys/capabilities-accessor` |
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
2018-03-01 16:14:56 +00:00
|
|
|
|
- `accessor` `(string: <required>)` – Accessor of the token for which
|
|
|
|
|
capabilities are being queried.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
2018-03-01 16:14:56 +00:00
|
|
|
|
- `paths` `(list: <required>)` – Paths on which capabilities are being
|
|
|
|
|
queried.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"accessor": "abcd1234",
|
2018-03-01 16:42:39 +00:00
|
|
|
|
"paths": ["secret/foo"]
|
2017-03-15 06:40:33 +00:00
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
2020-05-21 17:18:17 +00:00
|
|
|
|
```shell-session
|
2017-03-15 06:40:33 +00:00
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request POST \
|
2017-06-07 14:02:58 +00:00
|
|
|
|
--data @payload.json \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/capabilities-accessor
|
2017-03-15 06:40:33 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
2020-01-18 00:18:09 +00:00
|
|
|
|
"capabilities": ["delete", "list", "read", "update"],
|
|
|
|
|
"secret/foo": ["delete", "list", "read", "update"]
|
2017-03-15 06:40:33 +00:00
|
|
|
|
}
|
|
|
|
|
```
|