open-vault/website/source/api/system/policies.html.md

378 lines
8.9 KiB
Markdown
Raw Normal View History

2017-11-14 11:13:11 +00:00
---
layout: "api"
page_title: "/sys/policies/ - HTTP API"
sidebar_title: "<code>/sys/policies</code>"
New Docs Website (#5535) * conversion stage 1 * correct image paths * add sidebar title to frontmatter * docs/concepts and docs/internals * configuration docs and multi-level nav corrections * commands docs, index file corrections, small item nav correction * secrets converted * auth * add enterprise and agent docs * add extra dividers * secret section, wip * correct sidebar nav title in front matter for apu section, start working on api items * auth and backend, a couple directory structure fixes * remove old docs * intro side nav converted * reset sidebar styles, add hashi-global-styles * basic styling for nav sidebar * folder collapse functionality * patch up border length on last list item * wip restructure for content component * taking middleman hacking to the extreme, but its working * small css fix * add new mega nav * fix a small mistake from the rebase * fix a content resolution issue with middleman * title a couple missing docs pages * update deps, remove temporary markup * community page * footer to layout, community page css adjustments * wip downloads page * deps updated, downloads page ready * fix community page * homepage progress * add components, adjust spacing * docs and api landing pages * a bunch of fixes, add docs and api landing pages * update deps, add deploy scripts * add readme note * update deploy command * overview page, index title * Update doc fields Note this still requires the link fields to be populated -- this is solely related to copy on the description fields * Update api_basic_categories.yml Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages. * Add bottom hero, adjust CSS, responsive friendly * Add mega nav title * homepage adjustments, asset boosts * small fixes * docs page styling fixes * meganav title * some category link corrections * Update API categories page updated to reflect the second level headings for api categories * Update docs_detailed_categories.yml Updated to represent the existing docs structure * Update docs_detailed_categories.yml * docs page data fix, extra operator page remove * api data fix * fix makefile * update deps, add product subnav to docs and api landing pages * Rearrange non-hands-on guides to _docs_ Since there is no place for these on learn.hashicorp, we'll put them under _docs_. * WIP Redirects for guides to docs * content and component updates * font weight hotfix, redirects * fix guides and intro sidenavs * fix some redirects * small style tweaks * Redirects to learn and internally to docs * Remove redirect to `/vault` * Remove `.html` from destination on redirects * fix incorrect index redirect * final touchups * address feedback from michell for makefile and product downloads
2018-10-19 15:40:11 +00:00
sidebar_current: "api-http-system-policies"
2017-11-14 11:13:11 +00:00
description: |-
The `/sys/policies/` endpoints are used to manage ACL, RGP, and EGP policies in Vault.
---
# `/sys/policies/`
The `/sys/policies` endpoints are used to manage ACL, RGP, and EGP policies in Vault.
~> **NOTE**: This endpoint is only available in Vault version 0.9+. Please also note that RGPs and EGPs are Vault Enterprise Premium features and the associated endpoints are not available in Vault Open Source or Vault Enterprise Pro.
2017-11-14 11:13:11 +00:00
## List ACL Policies
This endpoint lists all configured ACL policies.
| Method | Path |
| :--------------------------- | :--------------------- |
| `LIST` | `/sys/policies/acl` |
2017-11-14 11:13:11 +00:00
### Sample Request
```
$ curl \
-X LIST --header "X-Vault-Token: ..." \
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/sys/policies/acl
2017-11-14 11:13:11 +00:00
```
### Sample Response
```json
{
"keys": ["root", "my-policy"]
}
```
## Read ACL Policy
This endpoint retrieves information about the named ACL policy.
| Method | Path |
| :--------------------------- | :--------------------- |
| `GET` | `/sys/policies/acl/:name` |
2017-11-14 11:13:11 +00:00
### 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: ..." \
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/sys/policies/acl/my-policy
2017-11-14 11:13:11 +00:00
```
### Sample Response
```json
{
"name": "deploy",
"policy": "path \"secret/foo\" {..."
}
```
## Create/Update ACL Policy
This endpoint adds a new or updates an existing ACL policy. Once a policy is
updated, it takes effect immediately to all associated users.
| Method | Path |
| :--------------------------- | :--------------------- |
| `PUT` | `/sys/policies/acl/:name` |
2017-11-14 11:13:11 +00:00
### Parameters
- `name` `(string: <required>)`  Specifies the name of the policy to create.
This is specified as part of the request URL.
- `policy` `(string: <required>)` - Specifies the policy document. This can be
base64-encoded to avoid string escaping.
### Sample Payload
```json
{
"policy": "path \"secret/foo\" {..."
}
```
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
--request PUT \
--data @payload.json \
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/sys/policies/acl/my-policy
2017-11-14 11:13:11 +00:00
```
## Delete ACL Policy
This endpoint deletes the ACL policy with the given name. This will immediately
affect all users associated with this policy. (A deleted policy set on a token
acts as an empty policy.)
| Method | Path |
| :--------------------------- | :--------------------- |
| `DELETE` | `/sys/policies/acl/:name` |
2017-11-14 11:13:11 +00:00
### 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 \
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/sys/policies/acl/my-policy
2017-11-14 11:13:11 +00:00
```
## List RGP Policies
This endpoint lists all configured RGP policies.
| Method | Path |
| :--------------------------- | :--------------------- |
| `LIST` | `/sys/policies/rgp` |
2017-11-14 11:13:11 +00:00
### Sample Request
```
$ curl \
-X LIST --header "X-Vault-Token: ..." \
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/sys/policies/rgp
2017-11-14 11:13:11 +00:00
```
### Sample Response
```json
{
"keys": ["webapp", "database"]
}
```
## Read RGP Policy
This endpoint retrieves information about the named RGP policy.
| Method | Path |
| :--------------------------- | :--------------------- |
| `GET` | `/sys/policies/rgp/:name` |
2017-11-14 11:13:11 +00:00
### 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: ..." \
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/sys/policies/rgp/webapp
2017-11-14 11:13:11 +00:00
```
### Sample Response
```json
{
"name": "webapp",
"policy": "rule main = {...",
"enforcement_level": "soft-mandatory"
}
```
## Create/Update RGP Policy
This endpoint adds a new or updates an existing RGP policy. Once a policy is
updated, it takes effect immediately to all associated users.
| Method | Path |
| :--------------------------- | :--------------------- |
| `PUT` | `/sys/policies/rgp/:name` |
2017-11-14 11:13:11 +00:00
### Parameters
- `name` `(string: <required>)`  Specifies the name of the policy to create.
This is specified as part of the request URL.
- `policy` `(string: <required>)` - Specifies the policy document. This can be
base64-encoded to avoid string escaping.
- `enforcement_level` `(string: <required>)` - Specifies the enforcement level
to use. This must be one of `advisory`, `soft-mandatory`, or
`hard-mandatory`.
### Sample Payload
```json
{
"policy": "rule main = {...",
"enforcement_level": "soft-mandatory"
}
```
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
--request PUT \
--data @payload.json \
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/sys/policies/rgp/webapp
2017-11-14 11:13:11 +00:00
```
## Delete RGP Policy
This endpoint deletes the RGP policy with the given name. This will immediately
affect all users associated with this policy. (A deleted policy set on a token
acts as an empty policy.)
| Method | Path |
| :--------------------------- | :--------------------- |
| `DELETE` | `/sys/policies/rgp/:name` |
2017-11-14 11:13:11 +00:00
### 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 \
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/sys/policies/rgp/webapp
2017-11-14 11:13:11 +00:00
```
## List EGP Policies
This endpoint lists all configured EGP policies. Since EGP policies act on a
path, this endpoint returns two identifiers:
* `keys` contains a mapping of names to associated paths in a format that
`vault list` understands
* `name_path_map` contains an object mapping names to paths and glob status in
a more machine-friendly format
| Method | Path |
| :--------------------------- | :--------------------- |
| `LIST` | `/sys/policies/egp` |
2017-11-14 11:13:11 +00:00
### Sample Request
```
$ curl \
-X LIST --header "X-Vault-Token: ..." \
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/sys/policies/egp
2017-11-14 11:13:11 +00:00
```
### Sample Response
```json
{
"keys": [ "breakglass" ]
}
```
## Read EGP Policy
This endpoint retrieves information about the named EGP policy.
| Method | Path |
| :--------------------------- | :--------------------- |
| `GET` | `/sys/policies/egp/:name` |
2017-11-14 11:13:11 +00:00
### 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: ..." \
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/sys/policies/egp/breakglass
2017-11-14 11:13:11 +00:00
```
### Sample Response
```json
{
"enforcement_level": "soft-mandatory",
"name": "breakglass",
"paths": [ "*" ],
"policy": "rule main = {..."
}
```
## Create/Update EGP Policy
This endpoint adds a new or updates an existing EGP policy. Once a policy is
updated, it takes effect immediately to all associated users.
| Method | Path |
| :--------------------------- | :--------------------- |
| `PUT` | `/sys/policies/egp/:name` |
2017-11-14 11:13:11 +00:00
### Parameters
- `name` `(string: <required>)`  Specifies the name of the policy to create.
This is specified as part of the request URL.
- `policy` `(string: <required>)` - Specifies the policy document. This can be
base64-encoded to avoid string escaping.
- `enforcement_level` `(string: <required>)` - Specifies the enforcement level
to use. This must be one of `advisory`, `soft-mandatory`, or
`hard-mandatory`.
- `paths` `(string or array: required)` - Specifies the paths on which this EGP
should be applied, either as a comma-separated list or an array. Glob
characters can denote suffixes, e.g. `secret/*`; a path of `*` will affect
all authenticated and login requests.
### Sample Payload
```json
{
"policy": "rule main = {...",
"paths": [ "*", "secret/*", "transit/keys/*" ],
"enforcement_level": "soft-mandatory"
}
```
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
--request PUT \
--data @payload.json \
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/sys/policies/egp/breakglass
2017-11-14 11:13:11 +00:00
```
## Delete EGP Policy
This endpoint deletes the EGP policy with the given name from all paths on which it was configured.
| Method | Path |
| :--------------------------- | :--------------------- |
| `DELETE` | `/sys/policies/egp/:name` |
2017-11-14 11:13:11 +00:00
### 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 \
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/sys/policies/egp/breakglass
2017-11-14 11:13:11 +00:00
```