Skip to content

Commit

Permalink
backport of commit f661f43 (#26124)
Browse files Browse the repository at this point in the history
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
  • Loading branch information
hc-github-team-secure-vault-core and schavis committed Mar 22, 2024
1 parent 4bfb027 commit d623bce
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
4 changes: 4 additions & 0 deletions website/content/docs/ui/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ at `http://127.0.0.1:8200/ui` and ready to use.

</Note>

## Policy requirements

@include 'ui/policy-requirements.mdx'

## Tutorial

Refer to the [UI quick start](/vault/tutorials/getting-started-ui) tutorials to
Expand Down
27 changes: 27 additions & 0 deletions website/content/partials/ui/policy-requirements.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<Warning title="Set UI policies before enabling the UI">

You cannot make policy adjustments or overwrites to the <code>ui/mounts</code>
and <code>ui/resultant-acl</code> endpoints once you enable the Vault UI. Vault
ignores policy updates that target these paths
with <a href="/vault/docs/concepts/policies#deny">explicit <code>deny</code></a> capabilities.

</Warning>

Depending on your Vault configuration, you may need to define UI policies
with different ACL capabilities from the permissions provided by your Vault CLI
policies.

The `default` UI policy includes two paths, **which cannot be modified with
additional policies** once you
[enable](/vault/docs/configuration/ui#activating-the-vault-ui) the UI:

- [/sys/internal/ui/mounts](/vault/api-docs/system/internal-ui-mounts) -
provides a list of currently visible mounts based on the
[`listing_visibility`](/vault/api-docs/system/mounts#listing_visibility)
parameter. `sys/internal/ui/mounts` is an unauthenticated, internal endpoint
used for UI and CLI preflight checks. Requests that include an `X-Vault-Token`
will return all mounts the token has path capabilities on.
- [/sys/internal/ui/resultant-acl](/vault/api-docs/system/internal-ui-resultant-acl) -
repackages authentication information used by the UI. **If you do not have have
permission to call the `ui/resultant-acl` endpoint, you may receive warnings or
errors in the UI**.

0 comments on commit d623bce

Please sign in to comment.