open-vault/website/source/api/system/capabilities-self.html.md
RJ Spiker fca7cb3794 website: update sidebar_title in front matter to use <code> (#5636)
* website: replace deprecated <tt> with <code> in front matter sidebar_title

* website: wrap front matter sidebar_title in <code> for commands pages
2018-10-29 15:58:37 -04:00

1.7 KiB
Raw Blame History

layout page_title sidebar_title sidebar_current description
api /sys/capabilities-self - HTTP API <code>/sys/capabilities-self</code> api-http-system-capabilities-self The `/sys/capabilities-self` endpoint is used to fetch the capabilities of client token on the given paths.

/sys/capabilities-self

The /sys/capabilities-self endpoint is used to fetch the capabilities of the token used to make the API call, 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 through the entity and entity's group memberships.

Query Self Capabilities

This endpoint returns the capabilities of client token on the given paths. The client token is the Vault token with which this API call is made. 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.

Method Path Produces
POST /sys/capabilities-self 200 application/json

Parameters

  • paths (list: <required>)  Paths on which capabilities are being queried.

Sample Payload

{
  "paths": ["secret/foo"]
}

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    http://127.0.0.1:8200/v1/sys/capabilities-self

Sample Response

{
  "capabilities": [
    "delete",
    "list",
    "read",
    "update"
  ],
  "secret/foo": [
    "delete",
    "list",
    "read",
    "update"
  ]
}