luxolus/open-vault
2
0
Fork 0
Code Issues 1 Pull requests Releases Activity
open-vault/website/source/docs/http/system/capabilities-accessor.html.md
Seth Vargo 19b2b049c3
Redo docs for system backend 
This commit updates the API documentation for the system backend to
break things apart on a per-page basis and provide specific examples.
This pattern will give more flexibility for future documentation as
well.
2017-03-16 09:46:49 -07:00

1.3 KiB
Raw Blame History

layout page_title sidebar_current description
http /sys/capabilities-accessor - HTTP API docs-http-system-capabilities-accessor The `/sys/capabilities-accessor` endpoint is used to fetch the capabilities of the token associated with an accessor, on the given path.

/sys/capabilities-accessor

The /sys/capabilities-accessor endpoint is used to fetch the capabilities of a token associated with an accessor.

Query Token Accessor Capabilities

This endpoint returns the capabilities of the token associated with an accessor, for the given path.

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

Parameters

  • accessor (string: <required>) – Specifies the accessor of the token to check.

  • path (string: <required>) – Specifies the path on which the token's capabilities will be checked.

Sample Payload

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

Sample Request

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

Sample Response

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