2017-03-15 02:40:33 -04:00
|
|
|
|
---
|
2017-03-17 14:06:03 -04:00
|
|
|
|
layout: "api"
|
2017-03-15 02:40:33 -04:00
|
|
|
|
page_title: "/sys/capabilities-accessor - HTTP API"
|
|
|
|
|
|
sidebar_current: "docs-http-system-capabilities-accessor"
|
|
|
|
|
|
description: |-
|
|
|
|
|
|
The `/sys/capabilities-accessor` endpoint is used to fetch the capabilities of
|
2018-03-01 11:42:39 -05:00
|
|
|
|
the token associated with an accessor, on the given paths.
|
2017-03-15 02:40:33 -04:00
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
# `/sys/capabilities-accessor`
|
|
|
|
|
|
|
2017-11-03 11:20:10 -04:00
|
|
|
|
The `/sys/capabilities-accessor` endpoint is used to fetch the capabilities of
|
2018-03-01 11:42:39 -05: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 02:40:33 -04:00
|
|
|
|
|
|
|
|
|
|
## Query Token Accessor Capabilities
|
|
|
|
|
|
|
2018-03-01 11:42:39 -05: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 02:40:33 -04:00
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
|
|
|
|
|
| `POST` | `/sys/capabilities-accessor` | `200 application/json` |
|
|
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
2018-03-01 11:14:56 -05:00
|
|
|
|
- `accessor` `(string: <required>)` – Accessor of the token for which
|
|
|
|
|
|
capabilities are being queried.
|
2017-03-15 02:40:33 -04:00
|
|
|
|
|
2018-03-01 11:14:56 -05:00
|
|
|
|
- `paths` `(list: <required>)` – Paths on which capabilities are being
|
|
|
|
|
|
queried.
|
2017-03-15 02:40:33 -04:00
|
|
|
|
|
|
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
|
{
|
|
|
|
|
|
"accessor": "abcd1234",
|
2018-03-01 11:42:39 -05:00
|
|
|
|
"paths": ["secret/foo"]
|
2017-03-15 02:40:33 -04:00
|
|
|
|
}
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
$ curl \
|
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
|
--request POST \
|
2017-06-07 10:02:58 -04:00
|
|
|
|
--data @payload.json \
|
2017-03-15 02:40:33 -04:00
|
|
|
|
https://vault.rocks/v1/sys/capabilities-accessor
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
|
{
|
2018-03-01 11:42:39 -05:00
|
|
|
|
"capabilities": [
|
|
|
|
|
|
"delete",
|
|
|
|
|
|
"list",
|
|
|
|
|
|
"read",
|
2018-03-01 11:14:56 -05:00
|
|
|
|
"update"
|
|
|
|
|
|
],
|
|
|
|
|
|
"secret/foo": [
|
|
|
|
|
|
"delete",
|
|
|
|
|
|
"list",
|
|
|
|
|
|
"read",
|
|
|
|
|
|
"update"
|
|
|
|
|
|
]
|
2017-03-15 02:40:33 -04:00
|
|
|
|
}
|
|
|
|
|
|
```
|