backport of commit cf43d3eeed23a8f098e002ccd094c2dfc4385b55 (#22788)

Co-authored-by: Bianca Moreira <48203644+biazmoreira@users.noreply.github.com>
This commit is contained in:
hc-github-team-secure-vault-core 2023-09-06 10:07:09 -04:00 committed by GitHub
parent ba9806c971
commit 4969480dfb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
36 changed files with 247 additions and 48 deletions

View File

@ -14,6 +14,8 @@ for a hashed value when the original value is known.
## Calculate hash ## Calculate hash
@include 'alerts/restricted-admin.mdx'
This endpoint hashes the given input data with the specified audit device's This endpoint hashes the given input data with the specified audit device's
hash function and salt. This endpoint can be used to discover whether a given hash function and salt. This endpoint can be used to discover whether a given
plaintext string (the `input` parameter) appears in the audit log in obfuscated plaintext string (the `input` parameter) appears in the audit log in obfuscated

View File

@ -12,6 +12,8 @@ token which can be used for all future requests.
## List auth methods ## List auth methods
@include 'alerts/restricted-admin.mdx'
This endpoint lists all enabled auth methods. This endpoint lists all enabled auth methods.
| Method | Path | | Method | Path |
@ -81,6 +83,8 @@ $ curl \
## Enable auth method ## Enable auth method
@include 'alerts/restricted-admin.mdx'
This endpoint enables a new auth method. After enabling, the auth method can This endpoint enables a new auth method. After enabling, the auth method can
be accessed and configured via the auth path specified as part of the URL. This be accessed and configured via the auth path specified as part of the URL. This
auth path will be nested under the `auth` prefix. auth path will be nested under the `auth` prefix.
@ -182,6 +186,8 @@ $ curl \
## Read auth method configuration ## Read auth method configuration
@include 'alerts/restricted-admin.mdx'
This endpoints returns the configuration of the auth method at the given path. This endpoints returns the configuration of the auth method at the given path.
| Method | Path | | Method | Path |
@ -231,6 +237,8 @@ $ curl \
## Disable auth method ## Disable auth method
@include 'alerts/restricted-admin.mdx'
This endpoint disables the auth method at the given auth path. This endpoint disables the auth method at the given auth path.
- **`sudo` required**  This endpoint requires `sudo` capability in addition to - **`sudo` required**  This endpoint requires `sudo` capability in addition to
@ -256,7 +264,9 @@ $ curl \
## Read auth method tuning ## Read auth method tuning
This endpoint reads the given auth path's configuration. _This endpoint requires @include 'alerts/restricted-admin.mdx'
- This endpoint reads the given auth path's configuration. This endpoint requires
`sudo` capability on the final path, but the same functionality can be achieved `sudo` capability on the final path, but the same functionality can be achieved
without `sudo` via `sys/mounts/auth/[auth-path]/tune`._ without `sudo` via `sys/mounts/auth/[auth-path]/tune`._
@ -293,6 +303,8 @@ $ curl \
## Tune auth method ## Tune auth method
@include 'alerts/restricted-admin.mdx'
Tune configuration parameters for a given auth path. _This endpoint Tune configuration parameters for a given auth path. _This endpoint
requires `sudo` capability on the final path, but the same functionality requires `sudo` capability on the final path, but the same functionality
can be achieved without `sudo` via `sys/mounts/auth/[auth-path]/tune`._ can be achieved without `sudo` via `sys/mounts/auth/[auth-path]/tune`._

View File

@ -16,6 +16,8 @@ memberships.
## Query self capabilities ## Query self capabilities
@include 'alerts/restricted-admin.mdx'
This endpoint returns the capabilities of client token on the given paths. The This endpoint returns the capabilities of client token on the given paths. The
client token is the Vault token with which this API call is made. Multiple client token is the Vault token with which this API call is made. Multiple
paths are taken in at once and the capabilities of the token for each path is paths are taken in at once and the capabilities of the token for each path is

View File

@ -15,6 +15,8 @@ through the entity and entity's group memberships.
## Query token capabilities ## Query token capabilities
@include 'alerts/restricted-admin.mdx'
This endpoint returns the list of capabilities of a given token on the given This endpoint returns the list of capabilities of a given token on the given
paths. Multiple paths are taken in at once and the capabilities of the token paths. Multiple paths are taken in at once and the capabilities of the token
for each path is returned. For backwards compatibility, if a single path is for each path is returned. For backwards compatibility, if a single path is

View File

@ -13,6 +13,8 @@ settings.
## Read control group settings ## Read control group settings
@include 'alerts/restricted-admin.mdx'
This endpoint returns the current Control Group configuration. This endpoint returns the current Control Group configuration.
| Method | Path | | Method | Path |
@ -37,6 +39,8 @@ $ curl \
## Configure control group settings ## Configure control group settings
@include 'alerts/restricted-admin.mdx'
This endpoint allows configuring control groups. This endpoint allows configuring control groups.
| Method | Path | | Method | Path |
@ -67,6 +71,8 @@ $ curl \
## Delete control group settings ## Delete control group settings
@include 'alerts/restricted-admin.mdx'
This endpoint removes any control group configuration. This endpoint removes any control group configuration.
| Method | Path | | Method | Path |

View File

@ -7,6 +7,7 @@ description: The '/sys/control-group' endpoint handles the Control Group workflo
## Authorize control group request ## Authorize control group request
@include 'alerts/enterprise-and-hcp-plus.mdx' @include 'alerts/enterprise-and-hcp-plus.mdx'
@include 'alerts/restricted-admin.mdx'
This endpoint authorizes a control group request. This endpoint authorizes a control group request.
@ -48,6 +49,8 @@ $ curl \
## Check control group request status ## Check control group request status
@include 'alerts/restricted-admin.mdx'
This endpoint checks the status of a control group request. This endpoint checks the status of a control group request.
| Method | Path | | Method | Path |

View File

@ -11,6 +11,8 @@ It lists the active node and the peers that it's heard from since it became acti
## HA status ## HA status
@include 'alerts/restricted-admin.mdx'
This endpoint returns the HA status of the Vault cluster. This endpoint returns the HA status of the Vault cluster.
| Method | Path | | Method | Path |

View File

@ -13,6 +13,8 @@ The `/sys/internal/counters` endpoints are used to return data about the number
## Entities ## Entities
@include 'alerts/restricted-admin.mdx'
This endpoint returns the total number of Entities. This endpoint returns the total number of Entities.
| Method | Path | | Method | Path |
@ -51,6 +53,8 @@ $ curl \
## Tokens ## Tokens
@include 'alerts/restricted-admin.mdx'
This endpoint returns the total number of Tokens. This endpoint returns the total number of Tokens.
| Method | Path | | Method | Path |
@ -89,6 +93,8 @@ $ curl \
## Client count ## Client count
@include 'alerts/restricted-admin.mdx'
This endpoint returns client activity information for a given billing This endpoint returns client activity information for a given billing
period, which is represented by the `start_time` and `end_time` parameters. period, which is represented by the `start_time` and `end_time` parameters.
@ -720,6 +726,8 @@ $ curl \
## Partial month client count ## Partial month client count
@include 'alerts/restricted-admin.mdx'
This endpoint returns the client activity in the current month. The response This endpoint returns the client activity in the current month. The response
will have activity attributions per namespace, per mount within each namespaces, will have activity attributions per namespace, per mount within each namespaces,
and new clients information. and new clients information.
@ -863,6 +871,8 @@ $ curl \
## Update the client count configuration ## Update the client count configuration
@include 'alerts/restricted-admin.mdx'
The `/sys/internal/counters/config` endpoint is used to configure logging of active clients. The `/sys/internal/counters/config` endpoint is used to configure logging of active clients.
| Method | Path | | Method | Path |
@ -901,6 +911,8 @@ $ curl \
## Read the client count configuration ## Read the client count configuration
@include 'alerts/restricted-admin.mdx'
Reading the configuration shows the current settings, as well as a flag as to whether any data can be queried. Reading the configuration shows the current settings, as well as a flag as to whether any data can be queried.
- `enabled` `(string)` - returns `default-enabled` or `default-disabled` if the configuration is `default`. - `enabled` `(string)` - returns `default-enabled` or `default-disabled` if the configuration is `default`.
@ -938,6 +950,8 @@ $ curl \
## Activity export ## Activity export
@include 'alerts/restricted-admin.mdx'
This endpoint returns an export of the clients that had activity within the This endpoint returns an export of the clients that had activity within the
provided start and end times. The returned set of client information will be provided start and end times. The returned set of client information will be
deduplicated over the time window and will show the earliest activity logged for deduplicated over the time window and will show the earliest activity logged for

View File

@ -25,6 +25,8 @@ structure, and other endpoints will be modified incrementally.
## Get OpenAPI document ## Get OpenAPI document
@include 'alerts/restricted-admin.mdx'
This endpoint returns a single OpenAPI document describing all paths visible to the requester. This endpoint returns a single OpenAPI document describing all paths visible to the requester.
| Method | Path | | Method | Path |

View File

@ -16,6 +16,8 @@ guarantee on backwards compatibility for this endpoint.
## Get enabled feature flags ## Get enabled feature flags
@include 'alerts/restricted-admin.mdx'
This endpoint lists the enabled feature flags relevant to the UI. This endpoint lists the enabled feature flags relevant to the UI.
| Method | Path | | Method | Path |

View File

@ -22,6 +22,8 @@ compatibility for this endpoint.
## Get available visible mounts ## Get available visible mounts
@include 'alerts/restricted-admin.mdx'
This endpoint lists all enabled auth methods. This endpoint lists all enabled auth methods.
| Method | Path | | Method | Path |
@ -59,6 +61,8 @@ $ curl \
## Get single mount details ## Get single mount details
@include 'alerts/restricted-admin.mdx'
This endpoint lists details for a specific mount path. This is an This endpoint lists details for a specific mount path. This is an
authenticated endpoint, and is currently only being used internally. authenticated endpoint, and is currently only being used internally.

View File

@ -15,6 +15,8 @@ intended usage, there is no guarantee on backwards compatibility for this endpoi
## Get resultant-acl ## Get resultant-acl
@include 'alerts/restricted-admin.mdx'
This endpoint lists the resultant-acl relevant to the UI. This endpoint lists the resultant-acl relevant to the UI.
| Method | Path | | Method | Path |

View File

@ -13,6 +13,8 @@ current leader of Vault.
## Read leader status ## Read leader status
@include 'alerts/restricted-admin.mdx'
This endpoint returns the high availability status and current leader instance This endpoint returns the high availability status and current leader instance
of Vault. of Vault.

View File

@ -10,6 +10,8 @@ The `/sys/leases` endpoints are used to view and manage leases in Vault.
## Read lease ## Read lease
@include 'alerts/restricted-admin.mdx'
This endpoint retrieve lease metadata. This endpoint retrieve lease metadata.
| Method | Path | | Method | Path |
@ -53,6 +55,8 @@ $ curl \
## List leases ## List leases
@include 'alerts/restricted-admin.mdx'
This endpoint returns a list of lease ids. This endpoint returns a list of lease ids.
**This endpoint requires 'sudo' capability.** **This endpoint requires 'sudo' capability.**
@ -82,6 +86,8 @@ $ curl \
## Renew lease ## Renew lease
@include 'alerts/restricted-admin.mdx'
This endpoint renews a lease, requesting to extend the lease. Token leases This endpoint renews a lease, requesting to extend the lease. Token leases
cannot be renewed using this endpoint, use instead the auth/token/renew endpoint. cannot be renewed using this endpoint, use instead the auth/token/renew endpoint.
@ -130,6 +136,8 @@ $ curl \
## Revoke lease ## Revoke lease
@include 'alerts/restricted-admin.mdx'
This endpoint revokes a lease immediately. This endpoint revokes a lease immediately.
| Method | Path | | Method | Path |
@ -166,6 +174,8 @@ $ curl \
## Revoke force ## Revoke force
@include 'alerts/restricted-admin.mdx'
This endpoint revokes all secrets or tokens generated under a given prefix This endpoint revokes all secrets or tokens generated under a given prefix
immediately. Unlike `/sys/leases/revoke-prefix`, this path ignores backend errors immediately. Unlike `/sys/leases/revoke-prefix`, this path ignores backend errors
encountered during revocation. This is _potentially very dangerous_ and should encountered during revocation. This is _potentially very dangerous_ and should
@ -198,6 +208,8 @@ $ curl \
## Revoke prefix ## Revoke prefix
@include 'alerts/restricted-admin.mdx'
This endpoint revokes all secrets (via a lease ID prefix) or tokens (via the This endpoint revokes all secrets (via a lease ID prefix) or tokens (via the
tokens' path property) generated under a given prefix immediately. This requires tokens' path property) generated under a given prefix immediately. This requires
`sudo` capability and access to it should be tightly controlled as it can be `sudo` capability and access to it should be tightly controlled as it can be
@ -228,6 +240,8 @@ $ curl \
## Tidy leases ## Tidy leases
@include 'alerts/restricted-admin.mdx'
This endpoint cleans up the dangling storage entries for leases: for each lease This endpoint cleans up the dangling storage entries for leases: for each lease
entry in storage, Vault will verify that it has an associated valid non-expired entry in storage, Vault will verify that it has an associated valid non-expired
token in storage, and if not, the lease will be revoked. token in storage, and if not, the lease will be revoked.
@ -251,6 +265,8 @@ $ curl \
## Lease counts ## Lease counts
@include 'alerts/restricted-admin.mdx'
This endpoint returns the total count of a `type` of lease, as well as a count This endpoint returns the total count of a `type` of lease, as well as a count
per mount point. Note that it currently only supports type "irrevocable". per mount point. Note that it currently only supports type "irrevocable".
@ -281,6 +297,8 @@ $ curl \
## Leases list ## Leases list
@include 'alerts/restricted-admin.mdx'
This endpoint returns the total count of a `type` of lease, as well as a list This endpoint returns the total count of a `type` of lease, as well as a list
of leases per mount point. Note that it currently only supports type of leases per mount point. Note that it currently only supports type
"irrevocable". "irrevocable".

View File

@ -15,6 +15,8 @@ Vault.
## License status ## License status
@include 'alerts/restricted-admin.mdx'
This endpoint returns information about licensing. See [license autoloading](/vault/docs/enterprise/license/autoloading) for additional background. This endpoint returns information about licensing. See [license autoloading](/vault/docs/enterprise/license/autoloading) for additional background.
In the response: In the response:

View File

@ -11,6 +11,8 @@ See the [Managed Keys](/vault/docs/enterprise/managed-keys) section for further
## List managed keys. ## List managed keys.
@include 'alerts/restricted-admin.mdx'
This endpoint lists all the Managed Keys of a certain type within the namespace. This endpoint lists all the Managed Keys of a certain type within the namespace.
| Method | Path | | Method | Path |
@ -43,6 +45,8 @@ $ curl \
## Create/Update managed key ## Create/Update managed key
@include 'alerts/restricted-admin.mdx'
An endpoint that will create or update a Managed Key within a given namespace. The :type refers to the backend type An endpoint that will create or update a Managed Key within a given namespace. The :type refers to the backend type
that the key is to use, such as `pkcs11`. The :name argument is unique name within all managed key types in that the key is to use, such as `pkcs11`. The :name argument is unique name within all managed key types in
the namespace. the namespace.
@ -262,6 +266,8 @@ $ curl \
## Read managed key ## Read managed key
@include 'alerts/restricted-admin.mdx'
This endpoint returns the managed key configuration at the given path. This endpoint returns the managed key configuration at the given path.
| Method | Path | | Method | Path |
@ -306,6 +312,8 @@ $ curl \
## Test sign with a managed key ## Test sign with a managed key
@include 'alerts/restricted-admin.mdx'
This endpoint allows an operator to validate that a managed key configuration works This endpoint allows an operator to validate that a managed key configuration works
by signing and verifying some randomly generated data. If the call returns a successful HTTP by signing and verifying some randomly generated data. If the call returns a successful HTTP
status code, the configuration can be considered valid. status code, the configuration can be considered valid.
@ -347,6 +355,8 @@ $ curl \
## Delete managed key ## Delete managed key
@include 'alerts/restricted-admin.mdx'
This endpoint deletes the managed key at the given path provided it is not This endpoint deletes the managed key at the given path provided it is not
listed within any mount point's `allowed_managed_keys`. listed within any mount point's `allowed_managed_keys`.

View File

@ -8,6 +8,8 @@ description: >-
# `/sys/mfa` # `/sys/mfa`
@include 'alerts/restricted-admin.mdx'
The `/sys/mfa` endpoint focuses on managing Multi-factor Authentication (MFA) The `/sys/mfa` endpoint focuses on managing Multi-factor Authentication (MFA)
behaviors in Vault Enterprise MFA. behaviors in Vault Enterprise MFA.

View File

@ -13,6 +13,8 @@ some log lines will be dropped.
## Monitor system logs ## Monitor system logs
@include 'alerts/restricted-admin.mdx'
This endpoint streams logs back to the client from Vault. Note that unlike most API endpoints in Vault, this one This endpoint streams logs back to the client from Vault. Note that unlike most API endpoints in Vault, this one
does not return JSON by default. This will send back data in whatever log format Vault has been configured with. By does not return JSON by default. This will send back data in whatever log format Vault has been configured with. By
default, this is text. default, this is text.

View File

@ -10,6 +10,8 @@ The `/sys/mounts` endpoint is used to manage secrets engines in Vault.
## List mounted secrets engines ## List mounted secrets engines
@include 'alerts/restricted-admin.mdx'
This endpoints lists all the mounted secrets engines. This endpoints lists all the mounted secrets engines.
| Method | Path | | Method | Path |
@ -119,6 +121,8 @@ are used by this backend.
## Enable secrets engine ## Enable secrets engine
@include 'alerts/restricted-admin.mdx'
This endpoint enables a new secrets engine at the given path. This endpoint enables a new secrets engine at the given path.
| Method | Path | | Method | Path |
@ -215,6 +219,8 @@ $ curl \
## Disable secrets engine ## Disable secrets engine
@include 'alerts/restricted-admin.mdx'
This endpoint disables the mount point specified in the URL. This endpoint disables the mount point specified in the URL.
| Method | Path | | | Method | Path | |
@ -249,6 +255,8 @@ in dangling credentials. This is meant for extreme circumstances.
## Get the configuration of a secret engine ## Get the configuration of a secret engine
@include 'alerts/restricted-admin.mdx'
This endpoint returns the configuration of a specific secret engine. This endpoint returns the configuration of a specific secret engine.
| Method | Path | | Method | Path |
@ -310,6 +318,8 @@ $ curl \
## Read mount configuration ## Read mount configuration
@include 'alerts/restricted-admin.mdx'
This endpoint reads the given mount's configuration. Unlike the `mounts` This endpoint reads the given mount's configuration. Unlike the `mounts`
endpoint, this will return the current time in seconds for each TTL, which may endpoint, this will return the current time in seconds for each TTL, which may
be the system default or a mount-specific value. be the system default or a mount-specific value.
@ -338,6 +348,8 @@ $ curl \
## Tune mount configuration ## Tune mount configuration
@include 'alerts/restricted-admin.mdx'
This endpoint tunes configuration parameters for a given mount point. This endpoint tunes configuration parameters for a given mount point.
| Method | Path | | Method | Path |

View File

@ -12,6 +12,8 @@ once registered backends can use the plugin by querying the catalog.
## LIST plugins ## LIST plugins
@include 'alerts/restricted-admin.mdx'
This endpoint lists the plugins in the catalog by type. This endpoint lists the plugins in the catalog by type.
| Method | Path | | Method | Path |
@ -83,6 +85,8 @@ $ curl \
## LIST plugins ## LIST plugins
@include 'alerts/restricted-admin.mdx'
This endpoint lists the plugins in the catalog by type. This endpoint lists the plugins in the catalog by type.
| Method | Path | | Method | Path |
@ -118,6 +122,8 @@ $ curl \
## Register plugin ## Register plugin
@include 'alerts/restricted-admin.mdx'
This endpoint registers a new plugin, or updates an existing one with the This endpoint registers a new plugin, or updates an existing one with the
supplied name. supplied name.
@ -175,6 +181,8 @@ $ curl \
## Read plugin ## Read plugin
@include 'alerts/restricted-admin.mdx'
This endpoint returns the configuration data for the plugin with the given name. This endpoint returns the configuration data for the plugin with the given name.
- **`sudo` required**  This endpoint requires `sudo` capability in addition to - **`sudo` required**  This endpoint requires `sudo` capability in addition to
@ -221,6 +229,8 @@ $ curl \
## Remove plugin from catalog ## Remove plugin from catalog
@include 'alerts/restricted-admin.mdx'
This endpoint removes the plugin with the given name. This endpoint removes the plugin with the given name.
- **`sudo` required**  This endpoint requires `sudo` capability in addition to - **`sudo` required**  This endpoint requires `sudo` capability in addition to

View File

@ -13,6 +13,8 @@ provided, all mounted paths that use that plugin backend will be reloaded.
## Reload plugins ## Reload plugins
@include 'alerts/restricted-admin.mdx'
This endpoint reloads mounted plugin backends. This endpoint reloads mounted plugin backends.
| Method | Path - | | Method | Path - |

View File

@ -18,6 +18,8 @@ as well as the syntax of the policies themselves.
## Create/Update password policy ## Create/Update password policy
@include 'alerts/restricted-admin.mdx'
This endpoint adds a new or updates an existing password policy. Once a policy is updated, This endpoint adds a new or updates an existing password policy. Once a policy is updated,
it takes effect immediately to all associated secret engines. it takes effect immediately to all associated secret engines.
@ -79,6 +81,8 @@ $ vault write sys/policies/password/my-policy policy=@my-policy.hcl
## List password policies ## List password policies
@include 'alerts/restricted-admin.mdx'
This endpoints list the password policies. This endpoints list the password policies.
| Method | Path | | Method | Path |
@ -116,6 +120,8 @@ $ curl \
## Read password policy ## Read password policy
@include 'alerts/restricted-admin.mdx'
This endpoint retrieves information about the named password policy. This endpoint retrieves information about the named password policy.
| Method | Path | | Method | Path |
@ -145,6 +151,8 @@ $ curl \
## Delete password policy ## Delete password policy
@include 'alerts/restricted-admin.mdx'
This endpoint deletes the password policy with the given name. This does not check if any This endpoint deletes the password policy with the given name. This does not check if any
secret engines are using it prior to deletion, so you should ensure that any engines that secret engines are using it prior to deletion, so you should ensure that any engines that
are utilizing this password policy are changed to a different policy (or to that engines' are utilizing this password policy are changed to a different policy (or to that engines'
@ -170,6 +178,8 @@ $ curl \
## Generate password from password policy ## Generate password from password policy
@include 'alerts/restricted-admin.mdx'
This endpoint generates a password from the specified existing password policy. This endpoint generates a password from the specified existing password policy.
| Method | Path | | Method | Path |

View File

@ -18,6 +18,8 @@ Vault Open Source or basic Vault Enterprise installations.
## List ACL policies ## List ACL policies
@include 'alerts/restricted-admin.mdx'
This endpoint lists all configured ACL policies. This endpoint lists all configured ACL policies.
| Method | Path | | Method | Path |
@ -42,6 +44,8 @@ $ curl \
## Read ACL policy ## Read ACL policy
@include 'alerts/restricted-admin.mdx'
This endpoint retrieves information about the named ACL policy. This endpoint retrieves information about the named ACL policy.
| Method | Path | | Method | Path |
@ -72,6 +76,8 @@ $ curl \
## Create/Update ACL policy ## Create/Update ACL policy
@include 'alerts/restricted-admin.mdx'
This endpoint adds a new or updates an existing ACL policy. Once a policy is This endpoint adds a new or updates an existing ACL policy. Once a policy is
updated, it takes effect immediately to all associated users. updated, it takes effect immediately to all associated users.
@ -107,6 +113,8 @@ $ curl \
## Delete ACL policy ## Delete ACL policy
@include 'alerts/restricted-admin.mdx'
This endpoint deletes the ACL policy with the given name. This will immediately 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 affect all users associated with this policy. (A deleted policy set on a token
acts as an empty policy.) acts as an empty policy.)
@ -131,6 +139,8 @@ $ curl \
## List RGP policies ## List RGP policies
@include 'alerts/restricted-admin.mdx'
This endpoint lists all configured RGP policies. This endpoint lists all configured RGP policies.
| Method | Path | | Method | Path |
@ -155,6 +165,8 @@ $ curl \
## Read RGP policy ## Read RGP policy
@include 'alerts/restricted-admin.mdx'
This endpoint retrieves information about the named RGP policy. This endpoint retrieves information about the named RGP policy.
| Method | Path | | Method | Path |
@ -186,6 +198,8 @@ $ curl \
## Create/Update RGP policy ## Create/Update RGP policy
@include 'alerts/restricted-admin.mdx'
This endpoint adds a new or updates an existing RGP policy. Once a policy is This endpoint adds a new or updates an existing RGP policy. Once a policy is
updated, it takes effect immediately to all associated users. updated, it takes effect immediately to all associated users.
@ -226,6 +240,8 @@ $ curl \
## Delete RGP policy ## Delete RGP policy
@include 'alerts/restricted-admin.mdx'
This endpoint deletes the RGP policy with the given name. This will immediately 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 affect all users associated with this policy. (A deleted policy set on a token
acts as an empty policy.) acts as an empty policy.)
@ -250,6 +266,8 @@ $ curl \
## List EGP policies ## List EGP policies
@include 'alerts/restricted-admin.mdx'
This endpoint lists all configured EGP policies. Since EGP policies act on a This endpoint lists all configured EGP policies. Since EGP policies act on a
path, this endpoint returns two identifiers: path, this endpoint returns two identifiers:
@ -280,6 +298,8 @@ $ curl \
## Read EGP policy ## Read EGP policy
@include 'alerts/restricted-admin.mdx'
This endpoint retrieves information about the named EGP policy. This endpoint retrieves information about the named EGP policy.
| Method | Path | | Method | Path |
@ -312,6 +332,8 @@ $ curl \
## Create/Update EGP policy ## Create/Update EGP policy
@include 'alerts/restricted-admin.mdx'
This endpoint adds a new or updates an existing EGP policy. Once a policy is This endpoint adds a new or updates an existing EGP policy. Once a policy is
updated, it takes effect immediately to all associated users. updated, it takes effect immediately to all associated users.
@ -358,6 +380,8 @@ $ curl \
## Delete EGP policy ## Delete EGP policy
@include 'alerts/restricted-admin.mdx'
This endpoint deletes the EGP policy with the given name from all paths on which it was configured. This endpoint deletes the EGP policy with the given name from all paths on which it was configured.
| Method | Path | | Method | Path |

View File

@ -10,6 +10,8 @@ The `/sys/policy` endpoint is used to manage ACL policies in Vault.
## List policies ## List policies
@include 'alerts/restricted-admin.mdx'
This endpoint lists all configured policies. This endpoint lists all configured policies.
| Method | Path | | Method | Path |
@ -34,6 +36,8 @@ $ curl \
## Read policy ## Read policy
@include 'alerts/restricted-admin.mdx'
This endpoint retrieve the policy body for the named policy. This endpoint retrieve the policy body for the named policy.
| Method | Path | | Method | Path |
@ -64,6 +68,8 @@ $ curl \
## Create/Update policy ## Create/Update policy
@include 'alerts/restricted-admin.mdx'
This endpoint adds a new or updates an existing policy. Once a policy is This endpoint adds a new or updates an existing policy. Once a policy is
updated, it takes effect immediately to all associated users. updated, it takes effect immediately to all associated users.
@ -98,6 +104,8 @@ $ curl \
## Delete policy ## Delete policy
@include 'alerts/restricted-admin.mdx'
This endpoint deletes the policy with the given name. This will immediately This endpoint deletes the policy with the given name. This will immediately
affect all users associated with this policy. affect all users associated with this policy.

View File

@ -12,11 +12,14 @@ The Remount documentation details the endpoints required to trigger and monitor
## Move backend ## Move backend
The `/sys/remount` endpoint moves an already-mounted backend to a new mount point. This process works for both secret @include 'alerts/restricted-admin.mdx'
The `/sys/remount` endpoint moves an already-mounted backend to a new mount point. Remounting works for both secret
engines and auth methods. engines and auth methods.
The remount operation returns a migration ID to the user. The user may utilize the migration ID to look up Vault returns a migration ID when the remount operation completes. You
the status of the mount migration. More details about the remount operation are described in can use the migration ID to look up the status of the mount migration.
More details about the remount operation are described in
[Mount Migration](/vault/docs/concepts/mount-migration). [Mount Migration](/vault/docs/concepts/mount-migration).
~> Note: This endpoint requires a policy with both `sudo` and `update` capabilities to `sys/remount` ~> Note: This endpoint requires a policy with both `sudo` and `update` capabilities to `sys/remount`
@ -82,6 +85,8 @@ $ curl \
## Monitor migration status ## Monitor migration status
@include 'alerts/restricted-admin.mdx'
This endpoint is used to monitor the status of a mount migration operation, using the ID returned in the response This endpoint is used to monitor the status of a mount migration operation, using the ID returned in the response
of the `sys/remount` call. The response contains the passed-in ID, the source and target mounts, and a status field of the `sys/remount` call. The response contains the passed-in ID, the source and target mounts, and a status field
that displays `in-progress`, `success` or `failure`. that displays `in-progress`, `success` or `failure`.

View File

@ -10,6 +10,8 @@ The `/sys/seal-status` endpoint is used to check the seal status of a Vault.
## Seal status ## Seal status
@include 'alerts/restricted-admin.mdx'
This endpoint returns the seal status of the Vault. This is an unauthenticated This endpoint returns the seal status of the Vault. This is an unauthenticated
endpoint. endpoint.

View File

@ -10,6 +10,8 @@ The `/sys/tools` endpoints are a general set of tools.
## Generate random bytes ## Generate random bytes
@include 'alerts/restricted-admin.mdx'
This endpoint returns high-quality random bytes of the specified length. This endpoint returns high-quality random bytes of the specified length.
| Method | Path | | Method | Path |
@ -59,6 +61,8 @@ $ curl \
## Hash data ## Hash data
@include 'alerts/restricted-admin.mdx'
This endpoint returns the cryptographic hash of given data using the specified This endpoint returns the cryptographic hash of given data using the specified
algorithm. algorithm.

View File

@ -8,11 +8,13 @@ description: The `/sys/locked-users` endpoint is used to manage locked users in
The `/sys/locked-users` endpoint is used to list and unlock locked users in Vault. The `/sys/locked-users` endpoint is used to list and unlock locked users in Vault.
Please visit [user lockout](/vault/docs/concepts/user-lockout) concepts page for more details about the feature. Refer to the [user lockout](/vault/docs/concepts/user-lockout) overview for more details about how Vault handles lockouts.
## List locked users ## List locked users
This endpoint lists the locked users information in Vault. @include 'alerts/restricted-admin.mdx'
The list endpoint returns information on the users currently locked by Vault.
The response will include all child namespaces of the namespace in which the The response will include all child namespaces of the namespace in which the
request was made. If some namespace has subsequently been deleted, its path will request was made. If some namespace has subsequently been deleted, its path will
@ -31,7 +33,7 @@ This endpoint was added in Vault 1.13.
- `mount_accessor` `(string, optional)` - Specifies the identifier of the auth mount entry to which the user - `mount_accessor` `(string, optional)` - Specifies the identifier of the auth mount entry to which the user
belongs in the namespace in which the request was made. If no mount accessor is specified, belongs in the namespace in which the request was made. If no mount accessor is specified,
the response will include locked users in all child namespaces of the namespace in which the request was made. the response includes locked users in all child namespaces of the namespace in which the request was made.
### Sample request ### Sample request
@ -193,8 +195,10 @@ $ curl \
## Unlock user ## Unlock user
This endpoint unlocks a locked user with provided mount_accessor and alias_identifier in namespace in which the request was made if locked. @include 'alerts/restricted-admin.mdx'
This command is idempotent, meaning it succeeds even if user with the given mount_accessor and alias_identifier is not locked.
The unlock user endpoint frees a locked user with the provided `mount_accessor` and `alias_identifier` in the given namespace.
The unlock command is idempotent. Calls to the endpoint succeed even if the user matching the provided `mount_accessor` and `alias_identifier` is not currently locked.
This endpoint was added in Vault 1.13. This endpoint was added in Vault 1.13.
@ -207,7 +211,7 @@ This endpoint was added in Vault 1.13.
- `mount_accessor` `(string, required)` - Specifies the identifier of the auth mount entry to which the user - `mount_accessor` `(string, required)` - Specifies the identifier of the auth mount entry to which the user
belongs belongs
- `alias_identifier` `(string, required)` - It is the name of the alias (user). For example, if the alias - `alias_identifier` `(string, required)` - The name of the alias (user). For example, if the alias
belongs to userpass backend, the name should be a valid username within userpass auth method. If the alias belongs belongs to userpass backend, the name should be a valid username within userpass auth method. If the alias belongs
to an approle auth method, the name should be a valid RoleID. If the alias belongs to an ldap auth method, the name to an approle auth method, the name should be a valid RoleID. If the alias belongs to an ldap auth method, the name
should be a valid username. should be a valid username.

View File

@ -13,6 +13,8 @@ The `/sys/version-history` endpoint is used to retrieve the version history of a
## Read version history ## Read version history
@include 'alerts/restricted-admin.mdx'
This endpoint returns the version history of the Vault. The response will contain the following keys: This endpoint returns the version history of the Vault. The response will contain the following keys:
- `keys`: a list of installed versions in chronological order based on the time installed - `keys`: a list of installed versions in chronological order based on the time installed

View File

@ -10,6 +10,8 @@ The `/sys/wrapping/lookup` endpoint returns wrapping token properties.
## Wrapping lookup ## Wrapping lookup
@include 'alerts/restricted-admin.mdx'
This endpoint looks up wrapping properties for the given token. This endpoint looks up wrapping properties for the given token.
| Method | Path | | Method | Path |

View File

@ -13,6 +13,8 @@ refresh its TTL.
## Wrapping rewrap ## Wrapping rewrap
@include 'alerts/restricted-admin.mdx'
This endpoint rewraps a response-wrapped token. The new token will use the same This endpoint rewraps a response-wrapped token. The new token will use the same
creation TTL as the original token and contain the same response. The old token creation TTL as the original token and contain the same response. The old token
will be invalidated. This can be used for long-term storage of a secret in a will be invalidated. This can be used for long-term storage of a secret in a

View File

@ -10,6 +10,8 @@ The `/sys/wrapping/unwrap` endpoint unwraps a wrapped response.
## Wrapping unwrap ## Wrapping unwrap
@include 'alerts/restricted-admin.mdx'
This endpoint returns the original response inside the given wrapping token. This endpoint returns the original response inside the given wrapping token.
Unlike simply reading `cubbyhole/response` (which is deprecated), this endpoint Unlike simply reading `cubbyhole/response` (which is deprecated), this endpoint
provides additional validation checks on the token, returns the original value provides additional validation checks on the token, returns the original value

View File

@ -13,6 +13,8 @@ token.
## Wrapping wrap ## Wrapping wrap
@include 'alerts/restricted-admin.mdx'
This endpoint wraps the given user-supplied data inside a response-wrapped This endpoint wraps the given user-supplied data inside a response-wrapped
token. token.

View File

@ -60,6 +60,19 @@ identities. This behavior can be configured using the [group-policy-application]
can be set to allow policies to be applied irrespective of namespace hierarchy, allowing sharing can be set to allow policies to be applied irrespective of namespace hierarchy, allowing sharing
across any namespace. across any namespace.
### Administrative namespaces
The Vault API includes system backend endpoints, which are mounted under the sys/ path.
System endpoints let you interact with the internal features of your Vault instance.
For security reasons, some of the system backend endpoints are restricted, and can only be called
from the root namespace or using a token in the root namespace with elevated permissions.
By default, Vault allows non-root calls to the less sensitive system backend endpoints.
However, there may be instances where a Vault operator needs to provide access to a subset
of the restricted endpoints, like sys/audit-hash and sys/monitor, without granting access
to the full set of privileged sys/ paths. An administrative namespace lets Vault operators grant
access to a subset of privileged endpoints by setting a parameter in their Vault configuration file.
## Usage ## Usage
API operations performed under a namespace can be done by providing the relative API operations performed under a namespace can be done by providing the relative

View File

@ -0,0 +1,3 @@
<Note title="Restricted endpoint">
The API path can only be called from the root or administrative namespace.
</Note>

View File

@ -0,0 +1,3 @@
<Note title="Restricted endpoint">
The API path can only be called from the root namespace.
</Note>