/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.
List ACL policies
This endpoint lists all configured ACL policies.
Method | Path |
---|---|
LIST | /sys/policies/acl |
Sample request
Sample response
Read ACL policy
This endpoint retrieves information about the named ACL policy.
Method | Path |
---|---|
GET | /sys/policies/acl/:name |
Parameters
name
(string: <required>)
– Specifies the name of the policy to retrieve. This is specified as part of the request URL.
Sample request
Sample response
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 |
---|---|
POST | /sys/policies/acl/:name |
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
Sample request
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 |
Parameters
name
(string: <required>)
– Specifies the name of the policy to delete. This is specified as part of the request URL.
Sample request
List RGP policies
This endpoint lists all configured RGP policies.
Method | Path |
---|---|
LIST | /sys/policies/rgp |
Sample request
Sample response
Read RGP policy
This endpoint retrieves information about the named RGP policy.
Method | Path |
---|---|
GET | /sys/policies/rgp/:name |
Parameters
name
(string: <required>)
– Specifies the name of the policy to retrieve. This is specified as part of the request URL.
Sample request
Sample response
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 |
---|---|
POST | /sys/policies/rgp/:name |
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 ofadvisory
,soft-mandatory
, orhard-mandatory
.
Sample payload
Sample request
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 |
Parameters
name
(string: <required>)
– Specifies the name of the policy to delete. This is specified as part of the request URL.
Sample request
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 thatvault list
understandsname_path_map
contains an object mapping names to paths and glob status in a more machine-friendly format
Method | Path |
---|---|
LIST | /sys/policies/egp |
Sample request
Sample response
Read EGP policy
This endpoint retrieves information about the named EGP policy.
Method | Path |
---|---|
GET | /sys/policies/egp/:name |
Parameters
name
(string: <required>)
– Specifies the name of the policy to retrieve. This is specified as part of the request URL.
Sample request
Sample response
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 |
---|---|
POST | /sys/policies/egp/:name |
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 ofadvisory
,soft-mandatory
, orhard-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
Sample request
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 |
Parameters
name
(string: <required>)
– Specifies the name of the policy to delete. This is specified as part of the request URL.
Sample request