luxolus/open-vault
2
0
Fork 0
Code Issues 1 Pull requests Releases Activity
open-vault/website/source/docs/http/system/policy.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

2.8 KiB
Raw Blame History

layout page_title sidebar_current description
http /sys/policy - HTTP API docs-http-system-policy The `/sys/policy` endpoint is used to manage ACL policies in Vault.

/sys/policy

The /sys/policy endpoint is used to manage ACL policies in Vault.

List Policies

This endpoint lists all configured policies.

Method Path Produces
GET /sys/policy 200 application/json

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    https://vault.rocks/v1/sys/policy

Sample Response

{
  "policies": ["root", "deploy"]
}

Read Policy

This endpoint retrieve the rules for the named policy.

Method Path Produces
GET /sys/policy/:name 200 application/json

Parameters

  • name (string: <required>) – Specifies the name of the policy to retrieve. This is specified as part of the request URL.

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    https://vault.rocks/v1/sys/policy/my-policy

Sample Response

{
  "rules": "path \"secret/foo\" {..."
}

Create/Update Policy

This endpoint adds a new or updates an existing policy. Once a policy is updated, it takes effect immediately to all associated users.

Method Path Produces
PUT /sys/policy/:name 204 (empty body)

Parameters

  • name (string: <required>) – Specifies the name of the policy to create. This is specified as part of the request URL.

  • rules (string: <required>) - Specifies the policy document.

Sample Payload

{
  "rules": "path \"secret/foo\" {..."
}

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request PUT \
    --data payload.json \
    https://vault.rocks/v1/sys/policy/my-policy

Delete Policy

This endpoint deletes the policy with the given name. This will immediately affect all users associated with this policy.

Method Path Produces
DELETE /sys/policy/:name 204 (empty body)

Parameters

  • name (string: <required>) – Specifies the name of the policy to delete. This is specified as part of the request URL.

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request DELETE \
    https://vault.rocks/v1/sys/policy/my-policy