mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-22 15:11:07 +02:00
0660ea6fac
* Update README Let contributors know that docs will now be located in UDR * Add comments to each mdx doc Comment has been added to all mdx docs that are not partials * chore: added changelog changelog check failure * wip: removed changelog * Fix content errors * Doc spacing * Update website/content/docs/deploy/kubernetes/vso/helm.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> --------- Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
68 lines
2.2 KiB
Plaintext
68 lines
2.2 KiB
Plaintext
---
|
||
layout: api
|
||
page_title: /sys/capabilities-accessor - HTTP API
|
||
description: |-
|
||
The `/sys/capabilities-accessor` endpoint is used to fetch the capabilities of
|
||
the token associated with an accessor, on the given paths.
|
||
---
|
||
|
||
> [!IMPORTANT]
|
||
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
|
||
|
||
# `/sys/capabilities-accessor`
|
||
|
||
The `/sys/capabilities-accessor` endpoint is used to fetch the capabilities of
|
||
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.
|
||
|
||
## Query token accessor capabilities
|
||
|
||
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.
|
||
|
||
@include 'api/no-capabilities.mdx'
|
||
|
||
| Method | Path |
|
||
| :----- | :--------------------------- |
|
||
| `POST` | `/sys/capabilities-accessor` |
|
||
|
||
### Parameters
|
||
|
||
- `accessor` `(string: <required>)` – Accessor of the token for which
|
||
capabilities are being queried.
|
||
|
||
- `paths` `(list: <required>)` – Paths on which capabilities are being
|
||
queried.
|
||
|
||
### Sample payload
|
||
|
||
```json
|
||
{
|
||
"accessor": "abcd1234",
|
||
"paths": ["secret/foo"]
|
||
}
|
||
```
|
||
|
||
### Sample request
|
||
|
||
```shell-session
|
||
$ curl \
|
||
--header "X-Vault-Token: ..." \
|
||
--request POST \
|
||
--data @payload.json \
|
||
http://127.0.0.1:8200/v1/sys/capabilities-accessor
|
||
```
|
||
|
||
### Sample response
|
||
|
||
```json
|
||
{
|
||
"capabilities": ["delete", "list", "read", "update"],
|
||
"secret/foo": ["delete", "list", "read", "update"]
|
||
}
|
||
```
|