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/capabilities - HTTP API"
|
|
|
|
|
sidebar_current: "docs-http-system-capabilities/"
|
|
|
|
|
description: |-
|
|
|
|
|
The `/sys/capabilities` endpoint is used to fetch the capabilities of a token
|
2018-03-01 16:42:39 +00:00
|
|
|
|
on the given paths.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# `/sys/capabilities`
|
|
|
|
|
|
2017-11-03 15:20:10 +00:00
|
|
|
|
The `/sys/capabilities` endpoint is used to fetch the capabilities of a token
|
2018-03-01 16:42:39 +00:00
|
|
|
|
on the given paths. 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
|
2017-11-03 15:20:10 +00:00
|
|
|
|
through the entity and entity's group memberships.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
|
|
|
|
## Query Token Capabilities
|
|
|
|
|
|
2018-03-01 16:42:39 +00:00
|
|
|
|
This endpoint returns the list of capabilities of a given token on the given
|
|
|
|
|
paths. Multiple paths are taken in at once and the capabilities of the token
|
|
|
|
|
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
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| :------- | :------------------- | :--------------------- |
|
|
|
|
|
| `POST` | `/sys/capabilities` | `200 application/json` |
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
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
|
|
|
|
|
2018-03-01 16:14:56 +00:00
|
|
|
|
- `token` `(string: <required>)` – Token for which capabilities are being
|
|
|
|
|
queried.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
2018-03-01 16:14:56 +00:00
|
|
|
|
"token": "abcd1234",
|
2018-03-01 16:42:39 +00:00
|
|
|
|
"paths": ["secret/foo"]
|
2017-03-15 06:40:33 +00:00
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request POST \
|
|
|
|
|
--data @payload.json \
|
|
|
|
|
https://vault.rocks/v1/sys/capabilities
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
2018-03-01 16:42:39 +00:00
|
|
|
|
"capabilities": [
|
|
|
|
|
"delete",
|
|
|
|
|
"list",
|
|
|
|
|
"read",
|
2018-03-01 16:14:56 +00:00
|
|
|
|
"update"
|
|
|
|
|
],
|
|
|
|
|
"secret/foo": [
|
|
|
|
|
"delete",
|
|
|
|
|
"list",
|
|
|
|
|
"read",
|
|
|
|
|
"update"
|
|
|
|
|
]
|
2017-03-15 06:40:33 +00:00
|
|
|
|
}
|
|
|
|
|
```
|