open-vault/website/source/api/system/capabilities.html.md
2017-03-17 14:06:03 -04:00

1.1 KiB
Raw Blame History

layout page_title sidebar_current description
api /sys/capabilities - HTTP API docs-http-system-capabilities/ The `/sys/capabilities` endpoint is used to fetch the capabilities of a token on a given path.

/sys/capabilities

The /sys/capabilities endpoint is used to fetch the capabilities of a token on a given path.

Query Token Capabilities

This endpoint returns the list of capabilities for a provided token.

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

Parameters

  • path (string: <required>)  Specifies the path against which to check the token's capabilities.

  • token (string: <required>)  Specifies the token for which to check capabilities.

Sample Payload

{
  "path": "secret/foo",
  "token": "abcd1234"
}

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    https://vault.rocks/v1/sys/capabilities

Sample Response

{
  "capabilities": ["read", "list"]
}