mirror of
https://github.com/optim-enterprises-bv/vault.git
synced 2025-10-30 02:02:43 +00:00
feat(website): migrates nav data format and updates docs pages (#11242)
* migrates nav data format and updates docs pages * removes sidebar_title from content files
This commit is contained in:
Bryce Kalow
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: AliCloud - Auth Methods - HTTP API
|
||||
sidebar_title: AliCloud
|
||||
description: This is the API documentation for the Vault AliCloud auth method.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: AppID - Auth Methods - HTTP API
|
||||
sidebar_title: App ID <sup>DEPRECATED</sup>
|
||||
description: This is the API documentation for the Vault App ID auth method.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: AppRole - Auth Methods - HTTP API
|
||||
sidebar_title: AppRole
|
||||
description: This is the API documentation for the Vault AppRole auth method.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: AWS - Auth Methods - HTTP API
|
||||
sidebar_title: AWS
|
||||
description: This is the API documentation for the Vault AWS auth method.
|
||||
---
|
||||
|
||||
@@ -517,7 +516,7 @@ $ curl \
|
||||
Configures the periodic tidying operation of the access listed identity entries.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :----------------------------------------- |
|
||||
| :----- | :------------------------------------------ |
|
||||
| `POST` | `/auth/aws/config/tidy/identity-accesslist` |
|
||||
|
||||
### Parameters
|
||||
@@ -551,7 +550,7 @@ $ curl \
|
||||
Returns the previously configured periodic access list tidying settings.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :----------------------------------------- |
|
||||
| :----- | :------------------------------------------ |
|
||||
| `GET` | `/auth/aws/config/tidy/identity-accesslist` |
|
||||
|
||||
### Sample Request
|
||||
@@ -578,7 +577,7 @@ $ curl \
|
||||
Deletes the previously configured periodic access list tidying settings.
|
||||
|
||||
| Method | Path |
|
||||
| :------- | :----------------------------------------- |
|
||||
| :------- | :------------------------------------------ |
|
||||
| `DELETE` | `/auth/aws/config/tidy/identity-accesslist` |
|
||||
|
||||
### Sample Request
|
||||
@@ -595,7 +594,7 @@ $ curl \
|
||||
Configures the periodic tidying operation of the deny listed role tag entries.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :---------------------------------------- |
|
||||
| :----- | :--------------------------------------- |
|
||||
| `POST` | `/auth/aws/config/tidy/roletag-denylist` |
|
||||
|
||||
### Parameters
|
||||
@@ -629,7 +628,7 @@ $ curl \
|
||||
Returns the previously configured periodic deny list tidying settings.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :---------------------------------------- |
|
||||
| :----- | :--------------------------------------- |
|
||||
| `GET` | `/auth/aws/config/tidy/roletag-denylist` |
|
||||
|
||||
### Sample Request
|
||||
@@ -656,7 +655,7 @@ $ curl \
|
||||
Deletes the previously configured periodic deny list tidying settings.
|
||||
|
||||
| Method | Path |
|
||||
| :------- | :---------------------------------------- |
|
||||
| :------- | :--------------------------------------- |
|
||||
| `DELETE` | `/auth/aws/config/tidy/roletag-denylist` |
|
||||
|
||||
### Sample Request
|
||||
@@ -1110,7 +1109,7 @@ placing the tag in the deny list does not invalidate the already issued
|
||||
token.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :-------------------------------------- |
|
||||
| :----- | :------------------------------------- |
|
||||
| `POST` | `/auth/aws/roletag-denylist/:role_tag` |
|
||||
|
||||
### Parameters
|
||||
@@ -1133,7 +1132,7 @@ $ curl \
|
||||
Returns the deny list entry of a previously deny listed role tag.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :-------------------------------------- |
|
||||
| :----- | :------------------------------------- |
|
||||
| `GET` | `/auth/aws/roletag-denylist/:role_tag` |
|
||||
|
||||
### Parameters
|
||||
@@ -1166,7 +1165,7 @@ $ curl \
|
||||
Lists all the role tags that are deny listed.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :---------------------------- |
|
||||
| :----- | :--------------------------- |
|
||||
| `LIST` | `/auth/aws/roletag-denylist` |
|
||||
|
||||
### Sample Request
|
||||
@@ -1195,7 +1194,7 @@ $ curl \
|
||||
Deletes a deny listed role tag.
|
||||
|
||||
| Method | Path |
|
||||
| :------- | :-------------------------------------- |
|
||||
| :------- | :------------------------------------- |
|
||||
| `DELETE` | `/auth/aws/roletag-denylist/:role_tag` |
|
||||
|
||||
### Parameters
|
||||
@@ -1219,7 +1218,7 @@ Cleans up the entries in the deny listed based on expiration time on the entry a
|
||||
`safety_buffer`.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :--------------------------------- |
|
||||
| :----- | :-------------------------------- |
|
||||
| `POST` | `/auth/aws/tidy/roletag-denylist` |
|
||||
|
||||
### Parameters
|
||||
@@ -1243,7 +1242,7 @@ Returns an entry in the identity access list. An entry will be created/updated b
|
||||
successful login.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :------------------------------------------ |
|
||||
| :----- | :------------------------------------------- |
|
||||
| `GET` | `/auth/aws/identity-accesslist/:instance_id` |
|
||||
|
||||
### Parameters
|
||||
@@ -1279,7 +1278,7 @@ $ curl \
|
||||
Lists all the instance IDs that are in the access list of successful logins.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :----------------------------- |
|
||||
| :----- | :------------------------------ |
|
||||
| `LIST` | `/auth/aws/identity-accesslist` |
|
||||
|
||||
### Sample Request
|
||||
@@ -1306,7 +1305,7 @@ $ curl \
|
||||
Deletes a cache of the successful login from an instance.
|
||||
|
||||
| Method | Path |
|
||||
| :------- | :------------------------------------------ |
|
||||
| :------- | :------------------------------------------- |
|
||||
| `DELETE` | `/auth/aws/identity-accesslist/:instance_id` |
|
||||
|
||||
### Parameters
|
||||
@@ -1330,7 +1329,7 @@ Cleans up the entries in the access list based on expiration time and
|
||||
`safety_buffer`.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :---------------------------------- |
|
||||
| :----- | :----------------------------------- |
|
||||
| `POST` | `/auth/aws/tidy/identity-accesslist` |
|
||||
|
||||
### Parameters
|
||||
@@ -1361,4 +1360,3 @@ URLs are deprecated. The affected APIs include:
|
||||
| `/auth/aws/tidy/roletag-denylist` | `/auth/aws/tidy/roletag-blacklist` |
|
||||
| `/auth/aws/config/tidy/identity-accesslist` | `/auth/aws/config/tidy/identity-whitelist` |
|
||||
| `/auth/aws/config/tidy/roletag-denylist` | `/auth/aws/config/tidy/roletag-blacklist` |
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Azure - Auth Methods - HTTP API
|
||||
sidebar_title: Azure
|
||||
description: |-
|
||||
This is the API documentation for the Vault Azure authentication
|
||||
method plugin.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: TLS Certificate - Auth Methods - HTTP API
|
||||
sidebar_title: TLS Certificates
|
||||
description: |-
|
||||
This is the API documentation for the Vault TLS Certificate authentication
|
||||
method.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Cloud Foundry - Auth Methods - HTTP API
|
||||
sidebar_title: Cloud Foundry
|
||||
description: This is the API documentation for the Vault Cloud Foundry auth method.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Google Cloud - Auth Methods - HTTP API
|
||||
sidebar_title: Google Cloud
|
||||
description: |-
|
||||
This is the API documentation for the Vault Google Cloud authentication
|
||||
method.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: GitHub - Auth Methods - HTTP API
|
||||
sidebar_title: GitHub
|
||||
description: This is the API documentation for the Vault GitHub auth method.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Auth Methods - HTTP API
|
||||
sidebar_title: Auth Methods
|
||||
description: |-
|
||||
Each auth method publishes its own set of API paths and methods.
|
||||
These endpoints are documented in this section.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: JWT/OIDC - Auth Methods - HTTP API
|
||||
sidebar_title: JWT/OIDC
|
||||
description: |-
|
||||
This is the API documentation for the Vault JWT/OIDC authentication
|
||||
method plugin.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Kerberos - Auth Methods - HTTP API
|
||||
sidebar_title: Kerberos
|
||||
description: This is the API documentation for the Vault Kerberos auth method plugin.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Kubernetes - Auth Methods - HTTP API
|
||||
sidebar_title: Kubernetes
|
||||
description: This is the API documentation for the Vault Kubernetes auth method plugin.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: LDAP - Auth Methods - HTTP API
|
||||
sidebar_title: LDAP
|
||||
description: This is the API documentation for the Vault LDAP auth method.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: OCI - Auth Methods - HTTP API
|
||||
sidebar_title: OCI
|
||||
description: This is the API documentation for the Vault OCI auth method plugin.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Okta - Auth Methods - HTTP API
|
||||
sidebar_title: Okta
|
||||
description: This is the API documentation for the Vault Okta auth method.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: RADIUS - Auth Methods - HTTP API
|
||||
sidebar_title: RADIUS
|
||||
description: This is the API documentation for the Vault RADIUS auth method.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Token - Auth Methods - HTTP API
|
||||
sidebar_title: Tokens
|
||||
description: This is the API documentation for the Vault token auth method.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Userpass - Auth Methods - HTTP API
|
||||
sidebar_title: Username & Password
|
||||
description: |-
|
||||
This is the API documentation for the Vault username and password
|
||||
auth method.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: HTTP API
|
||||
sidebar_title: Overview
|
||||
description: Vault has an HTTP API that can be used to control every aspect of Vault.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: 'HTTP API: Libraries'
|
||||
sidebar_title: Client Libraries
|
||||
description: >-
|
||||
List of official and community contributed libraries for interacting with the
|
||||
Vault HTTP API.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Related Tools
|
||||
sidebar_title: Related Tools
|
||||
description: Short list of third-party tools that work with or are related to Vault.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Active Directory - Secrets Engines - HTTP API
|
||||
sidebar_title: Active Directory
|
||||
description: This is the API documentation for the Vault Active Directory secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: AliCloud - Secrets Engines - HTTP API
|
||||
sidebar_title: AliCloud
|
||||
description: This is the API documentation for the Vault AliCloud secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: AWS - Secrets Engines - HTTP API
|
||||
sidebar_title: AWS
|
||||
description: This is the API documentation for the Vault AWS secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Azure - Secrets Engines - HTTP API
|
||||
sidebar_title: Azure
|
||||
description: This is the API documentation for the Vault Azure secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Cassandra - Secrets Engines - HTTP API
|
||||
sidebar_title: Cassandra <sup>DEPRECATED</sup>
|
||||
description: This is the API documentation for the Vault Cassandra secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Consul - Secrets Engines - HTTP API
|
||||
sidebar_title: Consul
|
||||
description: This is the API documentation for the Vault Consul secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Cubbyhole - Secrets Engines - HTTP API
|
||||
sidebar_title: Cubbyhole
|
||||
description: This is the API documentation for the Vault Cubbyhole secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Cassandra - Database - Secrets Engines - HTTP API
|
||||
sidebar_title: Cassandra
|
||||
description: >-
|
||||
The Cassandra plugin for Vault's database secrets engine generates database
|
||||
credentials to access Cassandra servers.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Couchbase - Database - Secrets Engines - HTTP API
|
||||
sidebar_title: Couchbase
|
||||
description: >-
|
||||
The Couchbase plugin for Vault's database secrets engine generates database
|
||||
credentials to access Couchbase servers.
|
||||
@@ -59,17 +58,17 @@ V_{{.DisplayName | uppercase | truncate 64}}_{{.RoleName | uppercase | truncate
|
||||
<details>
|
||||
<summary><b>Example Usernames:</b></summary>
|
||||
|
||||
| Example | |
|
||||
| ------------- | ---------------------------------------------------- |
|
||||
| `DisplayName` | `token` |
|
||||
| `RoleName` | `myrolename` |
|
||||
| Username | `V_TOKEN_MYROLENAME_USZT1N4CYHAL4M0XTGX3_1614294836` |
|
||||
| Example | |
|
||||
| ------------- | ---------------------------------------------------- |
|
||||
| `DisplayName` | `token` |
|
||||
| `RoleName` | `myrolename` |
|
||||
| Username | `V_TOKEN_MYROLENAME_USZT1N4CYHAL4M0XTGX3_1614294836` |
|
||||
|
||||
| Example | |
|
||||
| ------------- | ------------------------------------------------------------------------------ |
|
||||
| `DisplayName` | `amuchlonger_dispname` |
|
||||
| `RoleName` | `role-name-with-dashes` |
|
||||
| Username | `V_AMUCHLONGER_DISPNAME_ROLE-NAME-WITH-DASHES_S0T9XB0JSAB9NQZ7YJ40_1614294836` |
|
||||
| Example | |
|
||||
| ------------- | ------------------------------------------------------------------------------ |
|
||||
| `DisplayName` | `amuchlonger_dispname` |
|
||||
| `RoleName` | `role-name-with-dashes` |
|
||||
| Username | `V_AMUCHLONGER_DISPNAME_ROLE-NAME-WITH-DASHES_S0T9XB0JSAB9NQZ7YJ40_1614294836` |
|
||||
|
||||
</details>
|
||||
</details>
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Elasticsearch - Database - Secrets Engines - HTTP API
|
||||
sidebar_title: Elasticsearch
|
||||
description: >-
|
||||
The Elasticsearch plugin for Vault's database secrets engine generates
|
||||
database credentials to access Elasticsearch.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: HANA - Database - Secrets Engines - HTTP API
|
||||
sidebar_title: HanaDB
|
||||
description: >-
|
||||
The HANA plugin for Vault's database secrets engine generates database
|
||||
credentials to access HANA servers.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Database - Secrets Engines - HTTP API
|
||||
sidebar_title: Databases
|
||||
description: Top page for database secrets engine information
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Influxdb - Database - Secrets Engines - HTTP API
|
||||
sidebar_title: Influxdb
|
||||
description: >-
|
||||
The Influxdb plugin for Vault's database secrets engine generates database
|
||||
credentials to access Influxdb servers.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: MongoDB - Database - Secrets Engines - HTTP API
|
||||
sidebar_title: MongoDB
|
||||
description: >-
|
||||
The MongoDB plugin for Vault's database secrets engine generates database
|
||||
credentials to access MongoDB servers.
|
||||
@@ -59,17 +58,17 @@ has a number of parameters to further configure a connection.
|
||||
<details>
|
||||
<summary><b>Example Usernames:</b></summary>
|
||||
|
||||
| Example | |
|
||||
| ------------- | ---------------------------------------------------- |
|
||||
| `DisplayName` | `token` |
|
||||
| `RoleName` | `myrolename` |
|
||||
| Username | `v-token-myrolename-jNFRlKsZZMxJEx60o66i-1614294836` |
|
||||
| Example | |
|
||||
| ------------- | ---------------------------------------------------- |
|
||||
| `DisplayName` | `token` |
|
||||
| `RoleName` | `myrolename` |
|
||||
| Username | `v-token-myrolename-jNFRlKsZZMxJEx60o66i-1614294836` |
|
||||
|
||||
| Example | |
|
||||
| ------------- | ------------------------------------------------------------------- |
|
||||
| `DisplayName` | `amuchlonger_dispname` |
|
||||
| `RoleName` | `role-name-with-dashes` |
|
||||
| Username | `v-amuchlonger_dis-role-name-with--jNFRlKsZZMxJEx60o66i-1614294836` |
|
||||
| Example | |
|
||||
| ------------- | ------------------------------------------------------------------- |
|
||||
| `DisplayName` | `amuchlonger_dispname` |
|
||||
| `RoleName` | `role-name-with-dashes` |
|
||||
| Username | `v-amuchlonger_dis-role-name-with--jNFRlKsZZMxJEx60o66i-1614294836` |
|
||||
|
||||
</details>
|
||||
</details>
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: 'api'
|
||||
page_title: 'MongoDB Atlas - Database - Secrets Engines - HTTP API'
|
||||
sidebar_title: 'MongoDB Atlas'
|
||||
description: |-
|
||||
The MongoDB Atlas plugin for Vault's Database Secrets Engine generates MongoDB Database User credentials for MongoDB Atlas.
|
||||
---
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: MSSQL - Database - Secrets Engines - HTTP API
|
||||
sidebar_title: MSSQL
|
||||
description: >-
|
||||
The MSSQL plugin for Vault's database secrets engine generates database
|
||||
credentials to access MSSQL servers.
|
||||
@@ -58,17 +57,17 @@ has a number of parameters to further configure a connection.
|
||||
<details>
|
||||
<summary><b>Example Usernames:</b></summary>
|
||||
|
||||
| Example | |
|
||||
| ------------- | ---------------------------------------------------- |
|
||||
| `DisplayName` | `token` |
|
||||
| `RoleName` | `myrolename` |
|
||||
| Username | `v-token-myrolename-jNFRlKsZZMxJEx60o66i-1614294836` |
|
||||
| Example | |
|
||||
| ------------- | ---------------------------------------------------- |
|
||||
| `DisplayName` | `token` |
|
||||
| `RoleName` | `myrolename` |
|
||||
| Username | `v-token-myrolename-jNFRlKsZZMxJEx60o66i-1614294836` |
|
||||
|
||||
| Example | |
|
||||
| ------------- | ----------------------------------------------------------------------------- |
|
||||
| `DisplayName` | `amuchlonger_dispname` |
|
||||
| `RoleName` | `role-name-with-dashes` |
|
||||
| Username | `v-amuchlonger_dispname-role-name-with-dashe-LUHU9xqm6YNisikA3iCQ-1614294836` |
|
||||
| Example | |
|
||||
| ------------- | ----------------------------------------------------------------------------- |
|
||||
| `DisplayName` | `amuchlonger_dispname` |
|
||||
| `RoleName` | `role-name-with-dashes` |
|
||||
| Username | `v-amuchlonger_dispname-role-name-with-dashe-LUHU9xqm6YNisikA3iCQ-1614294836` |
|
||||
|
||||
</details>
|
||||
</details>
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: MySQL/MariaDB - Database - Secrets Engines - HTTP API
|
||||
sidebar_title: MySQL/MariaDB
|
||||
description: >-
|
||||
The MySQL/MariaDB plugin for Vault's database secrets engine generates
|
||||
database credentials to access MySQL and MariaDB servers.
|
||||
@@ -95,17 +94,17 @@ has a number of parameters to further configure a connection.
|
||||
<details>
|
||||
<summary><b>Example Usernames:</b></summary>
|
||||
|
||||
| Example | |
|
||||
| ------------- | ------------------ |
|
||||
| `DisplayName` | `token` |
|
||||
| `RoleName` | `myrolename` |
|
||||
| Username | `v-myro-jNFRlKsZZ` |
|
||||
| Example | |
|
||||
| ------------- | ------------------ |
|
||||
| `DisplayName` | `token` |
|
||||
| `RoleName` | `myrolename` |
|
||||
| Username | `v-myro-jNFRlKsZZ` |
|
||||
|
||||
| Example | |
|
||||
| ------------- | ----------------------- |
|
||||
| `DisplayName` | `amuchlonger_dispname` |
|
||||
| `RoleName` | `role-name-with-dashes` |
|
||||
| Username | `v-role-b9ODeKsfl` |
|
||||
| Example | |
|
||||
| ------------- | ----------------------- |
|
||||
| `DisplayName` | `amuchlonger_dispname` |
|
||||
| `RoleName` | `role-name-with-dashes` |
|
||||
| Username | `v-role-b9ODeKsfl` |
|
||||
|
||||
</details>
|
||||
</details>
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Oracle - Database - Secrets Engines - HTTP API
|
||||
sidebar_title: Oracle
|
||||
description: >-
|
||||
The Oracle plugin for Vault's database secrets engine generates database
|
||||
credentials to access Oracle servers.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: PostgreSQL - Database - Secrets Engines - HTTP API
|
||||
sidebar_title: PostgreSQL
|
||||
description: >-
|
||||
The PostgreSQL plugin for Vault's database secrets engine generates database
|
||||
credentials to access PostgreSQL servers.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Redshift - Database - Secrets Engines - HTTP API
|
||||
sidebar_title: Redshift
|
||||
description: >-
|
||||
The Redshift plugin for Vault's database secrets engine generates database
|
||||
credentials to access the AWS Redshift service.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Snowflake - Database - Secrets Engines - HTTP API
|
||||
sidebar_title: Snowflake
|
||||
description: >-
|
||||
The Snowflake plugin for Vault's database secrets engine generates database
|
||||
credentials to access Snowflake servers.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Google Cloud - Secrets Engines - HTTP API
|
||||
sidebar_title: Google Cloud
|
||||
description: This is the API documentation for the Vault Google Cloud secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Google Cloud KMS - Secrets Engines - HTTP API
|
||||
sidebar_title: Google Cloud KMS
|
||||
description: This is the API documentation for the Vault Google Cloud KMS secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: 'Identity Secret Backend: Entity Alias - HTTP API'
|
||||
sidebar_title: Entity Alias
|
||||
description: >-
|
||||
This is the API documentation for managing entity aliases in the identity
|
||||
store.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: 'Identity Secret Backend: Entity - HTTP API'
|
||||
sidebar_title: Entity
|
||||
description: This is the API documentation for managing entities in the identity store.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: 'Identity Secret Backend: Group Alias - HTTP API'
|
||||
sidebar_title: Group Alias
|
||||
description: >-
|
||||
This is the API documentation for managing the group aliases in the identity
|
||||
store.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: 'Identity Secret Backend: Group - HTTP API'
|
||||
sidebar_title: Group
|
||||
description: This is the API documentation for managing groups in the identity store.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Identity - Secrets Engines - HTTP API
|
||||
sidebar_title: Identity
|
||||
description: This is the API documentation for the Vault Identity secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: 'Identity Secret Backend: Lookup - HTTP API'
|
||||
sidebar_title: Lookup
|
||||
description: |-
|
||||
This is the API documentation for entity and group lookups from identity
|
||||
store.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: 'Identity Secret Backend: Identity Tokens - HTTP API'
|
||||
sidebar_title: Identity Tokens
|
||||
description: >-
|
||||
This is the API documentation for configuring, acquiring, and validating vault
|
||||
issued identity tokens.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Secrets Engines - HTTP API
|
||||
sidebar_title: Secrets Engines
|
||||
description: |-
|
||||
Each secrets engine publishes its own set of API paths and methods. These
|
||||
endpoints are documented in this section.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: AWS KMS - Key Management - Secrets Engines - HTTP API
|
||||
sidebar_title: AWS KMS
|
||||
description: The AWS KMS API documentation for the Key Management secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Azure Key Vault - Key Management - Secrets Engines - HTTP API
|
||||
sidebar_title: Azure Key Vault
|
||||
description: The Azure Key Vault API documentation for the Key Management secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Key Management - Secrets Engines - HTTP API
|
||||
sidebar_title: Key Management <sup>ENTERPRISE</sup>
|
||||
description: The API documentation for the Key Management secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: KMIP - Secrets Engines - HTTP API
|
||||
sidebar_title: KMIP <sup>ENTERPRISE</sup>
|
||||
description: This is the API documentation for the Vault KMIP secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: KV - Secrets Engines - HTTP API
|
||||
sidebar_title: Key/Value
|
||||
description: This is the API documentation for the Vault KV secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: KV - Secrets Engines - HTTP API
|
||||
sidebar_title: K/V Version 1
|
||||
description: This is the API documentation for the Vault KV secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: KV - Secrets Engines - HTTP API
|
||||
sidebar_title: K/V Version 2
|
||||
description: This is the API documentation for the Vault KV secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: MongoDB Atlas - Secrets Engines - HTTP API
|
||||
sidebar_title: MongoDB Atlas
|
||||
description: |-
|
||||
The MongoDB Atlas Secrets Engine for Vault generates MongoDB Atlas Programmatic API Keys dynamically.
|
||||
---
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Nomad Secret Backend - HTTP API
|
||||
sidebar_title: Nomad
|
||||
description: This is the API documentation for the Vault Nomad secret backend.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: OpenLDAP - Secrets Engines - HTTP API
|
||||
sidebar_title: OpenLDAP
|
||||
description: This is the API documentation for the Vault OpenLDAP secrets engine.
|
||||
---
|
||||
|
||||
@@ -226,7 +225,6 @@ $ curl \
|
||||
http://127.0.0.1:8200/v1/openldap/static-cred/hashicorp
|
||||
```
|
||||
|
||||
|
||||
#### Sample Get Response
|
||||
|
||||
```json
|
||||
@@ -267,7 +265,7 @@ OpenLDAP domain user account.
|
||||
#### Parameters
|
||||
|
||||
| Method | Path |
|
||||
| :------- | :------------------------- |
|
||||
| :------- | :-------------------------- |
|
||||
| `POST` | `/openldap/role/:role_name` |
|
||||
| `DELETE` | `/openldap/role/:role_name` |
|
||||
|
||||
@@ -341,6 +339,7 @@ The `creation_ldif`, `deletion_ldif`, `rollback_ldif`, and `username_template` f
|
||||
Sample LDIF files:
|
||||
|
||||
`creation.ldif`:
|
||||
|
||||
```
|
||||
dn: cn={{.Username}},ou=users,dc=learn,dc=example
|
||||
objectClass: person
|
||||
@@ -372,7 +371,7 @@ Full Payload:
|
||||
```
|
||||
|
||||
-> Note: The LDIF statements may optionally be base64 encoded. If they are base64 encoded when creating/updating the
|
||||
role configuration, the decoded version will be returned from the `GET` endpoint.
|
||||
role configuration, the decoded version will be returned from the `GET` endpoint.
|
||||
|
||||
#### Sample POST Request
|
||||
|
||||
@@ -387,7 +386,7 @@ $ curl \
|
||||
### Read Dynamic Role Configuration
|
||||
|
||||
| Method | Path |
|
||||
| ------ | -------------------------- |
|
||||
| ------ | --------------------------- |
|
||||
| `GET` | `/openldap/role/:role_name` |
|
||||
|
||||
Retrieves a dynamic role's configuration.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: PKI - Secrets Engines - HTTP API
|
||||
sidebar_title: PKI
|
||||
description: This is the API documentation for the Vault PKI secrets engine.
|
||||
---
|
||||
|
||||
@@ -1611,7 +1610,7 @@ This table outlines which operations can be executed on performance standbys
|
||||
and thus scale horizontally.
|
||||
|
||||
| Path | Operations |
|
||||
| --------------------------- | ------------------- |
|
||||
| --------------------------- | -------------------- |
|
||||
| ca[/pem] | Read |
|
||||
| cert/<em>serial-number</em> | Read |
|
||||
| cert/ca_chain | Read |
|
||||
@@ -1620,15 +1619,12 @@ and thus scale horizontally.
|
||||
| ca_chain | Read |
|
||||
| crl[/pem] | Read |
|
||||
| crl/pem | Read |
|
||||
| issue | Update <sup>*</sup> |
|
||||
| revoked/* | Read, List |
|
||||
| sign | Update <sup>*</sup> |
|
||||
| sign-verbatim | Update <sup>*</sup> |
|
||||
| issue | Update <sup>\*</sup> |
|
||||
| revoked/\* | Read, List |
|
||||
| sign | Update <sup>\*</sup> |
|
||||
| sign-verbatim | Update <sup>\*</sup> |
|
||||
|
||||
\* Only if the corresponding role has `no_store` set to true and `generate_lease`
|
||||
set to false. If `generate_lease` is true the lease creation will be forwarded to
|
||||
the active node; if `no_store` is false the entire request will be forwarded to
|
||||
the active node.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: RabbitMQ - Secrets Engines - HTTP API
|
||||
sidebar_title: RabbitMQ
|
||||
description: This is the API documentation for the Vault RabbitMQ secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: SSH - Secrets Engines - HTTP API
|
||||
sidebar_title: SSH
|
||||
description: This is the API documentation for the Vault SSH secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Terraform Cloud Secret Backend - HTTP API
|
||||
sidebar_title: Terraform Cloud
|
||||
description: This is the API documentation for the Vault Terraform Cloud secret backend.
|
||||
---
|
||||
|
||||
@@ -22,7 +21,7 @@ information is used so that Vault can communicate with Terraform Cloud and gener
|
||||
Terraform Cloud tokens.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :--------------------- |
|
||||
| :----- | :------------------ |
|
||||
| `POST` | `/terraform/config` |
|
||||
|
||||
### Parameters
|
||||
@@ -35,7 +34,6 @@ Terraform Cloud tokens.
|
||||
use. This token must have the needed permissions to manage all Organization,
|
||||
Team, and User tokens desired for this mount.
|
||||
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
@@ -60,7 +58,7 @@ $ curl \
|
||||
This endpoint queries for information about the Terraform Cloud connection.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :--------------------- |
|
||||
| :----- | :------------------ |
|
||||
| `GET` | `/terraform/config` |
|
||||
|
||||
### Sample Request
|
||||
@@ -80,7 +78,6 @@ $ curl \
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## Create/Update Role
|
||||
|
||||
This endpoint creates or updates the Terraform Cloud role definition in Vault.
|
||||
@@ -92,7 +89,7 @@ access: Organizations, Teams, and Users. A Vault Role can manage a single type
|
||||
of API token at a time, determined by how it is configured:
|
||||
|
||||
- To manage an Organization API token, provide the organization
|
||||
name with the `organization` parameter
|
||||
name with the `organization` parameter
|
||||
- To manage a Team API token, provide the `team_id` parameter
|
||||
- To manage a User API token, provide a `user_id` parameter
|
||||
|
||||
@@ -107,9 +104,8 @@ Please see the [Terraform Cloud API
|
||||
Token documentation for more
|
||||
information](https://www.terraform.io/docs/cloud/users-teams-organizations/api-tokens.html).
|
||||
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :------------------ |
|
||||
| :----- | :---------------------- |
|
||||
| `POST` | `/terraform/role/:name` |
|
||||
|
||||
### Parameters
|
||||
@@ -136,7 +132,6 @@ information](https://www.terraform.io/docs/cloud/users-teams-organizations/api-t
|
||||
as a string duration with a time suffix like `"30s"` or `"1h"` or as seconds. If not
|
||||
provided, the default Vault Max TTL is used. Only applies to User API tokens.
|
||||
|
||||
|
||||
### Sample Payload
|
||||
|
||||
To create a Vault role to manage a Terraform Cloud User tokens
|
||||
@@ -144,8 +139,8 @@ To create a Vault role to manage a Terraform Cloud User tokens
|
||||
```json
|
||||
{
|
||||
"user_id": "user-glhf1234",
|
||||
"ttl":"1h",
|
||||
"max_ttl":"24h",
|
||||
"ttl": "1h",
|
||||
"max_ttl": "24h"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -165,7 +160,7 @@ This endpoint queries for information about a Terraform Cloud role with the give
|
||||
If no role exists with that name, a 404 is returned.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :------------------ |
|
||||
| :----- | :---------------------- |
|
||||
| `GET` | `/terraform/role/:name` |
|
||||
|
||||
### Parameters
|
||||
@@ -190,7 +185,7 @@ $ curl \
|
||||
"name": "tfuser",
|
||||
"ttl": 3600,
|
||||
"user_id": "user-glhf1234"
|
||||
},
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -199,7 +194,7 @@ $ curl \
|
||||
This endpoint lists all existing roles in the backend.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :---------------------- |
|
||||
| :----- | :-------------------------- |
|
||||
| `LIST` | `/terraform/role` |
|
||||
| `GET` | `/terraform/role?list=true` |
|
||||
|
||||
@@ -228,7 +223,7 @@ This endpoint deletes a Terraform Cloud role with the given name. Even if the ro
|
||||
not exist, this endpoint will still return a successful response.
|
||||
|
||||
| Method | Path |
|
||||
| :------- | :------------------ |
|
||||
| :------- | :---------------------- |
|
||||
| `DELETE` | `/terraform/role/:name` |
|
||||
|
||||
### Parameters
|
||||
@@ -251,9 +246,8 @@ This endpoint rotates the credentials for a Terraform Cloud role that manages an
|
||||
Organization or Team. This endpoint is only valid for those roles; attempting to
|
||||
rotate a role that manages user tokens will result in an error.
|
||||
|
||||
|
||||
| Method | Path |
|
||||
| :------- | :------------------ |
|
||||
| :----- | :----------------------------- |
|
||||
| `POST` | `/terraform/rotate-role/:name` |
|
||||
|
||||
### Parameters
|
||||
@@ -278,7 +272,7 @@ until the token is rotated with `rotate-role`. For User roles, a new token is
|
||||
generated with each request.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :------------------- |
|
||||
| :----- | :----------------------- |
|
||||
| `GET` | `/terraform/creds/:name` |
|
||||
|
||||
### Parameters
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: TOTP - Secrets Engines - HTTP API
|
||||
sidebar_title: TOTP
|
||||
description: This is the API documentation for the Vault TOTP secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Transform - Secrets Engines - HTTP API
|
||||
sidebar_title: Transform <sup>ENTERPRISE</sup>
|
||||
description: This is the API documentation for the Transform secrets engine.
|
||||
---
|
||||
|
||||
@@ -212,7 +211,7 @@ transformation with the name does not exist, it will be created. If the
|
||||
transformation exists, it will be updated with the new attributes.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :------------------------------------ |
|
||||
| :----- | :------------------------------------- |
|
||||
| `POST` | `/transform/transformations/fpe/:name` |
|
||||
|
||||
### Parameters
|
||||
@@ -261,7 +260,7 @@ transformation with the name does not exist, it will be created. If the
|
||||
transformation exists, it will be updated with the new attributes.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :---------------------------------------- |
|
||||
| :----- | :----------------------------------------- |
|
||||
| `POST` | `/transform/transformations/masking/:name` |
|
||||
|
||||
### Parameters
|
||||
@@ -311,7 +310,7 @@ transformation with the name does not exist, it will be created. If the
|
||||
transformation exists, it will be updated with the new attributes.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :--------------------------------------------- |
|
||||
| :----- | :---------------------------------------------- |
|
||||
| `POST` | `/transform/transformations/tokenization/:name` |
|
||||
|
||||
### Parameters
|
||||
@@ -362,7 +361,7 @@ $ curl \
|
||||
This endpoint queries an existing transformation by the given name.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :-------------------------------- |
|
||||
| :----- | :--------------------------------- |
|
||||
| `GET` | `/transform/transformations/:name` |
|
||||
|
||||
- `name` `(string: <required>)` –
|
||||
@@ -421,7 +420,7 @@ $ curl
|
||||
This endpoint deletes an existing transformation by the given name.
|
||||
|
||||
| Method | Path |
|
||||
| :------- | :-------------------------------- |
|
||||
| :------- | :--------------------------------- |
|
||||
| `DELETE` | `/transform/transformations/:name` |
|
||||
|
||||
### Parameters
|
||||
@@ -716,7 +715,8 @@ The database user configured here should only have permission to `SELECT`,
|
||||
A database connection string with template slots for username and password that
|
||||
Vault will use for locating and connecting to a database. Each
|
||||
database driver type has a different syntax for its connection strings.
|
||||
> When using MySQL, make sure to append `?parseTime=true` to enable timestamp parsing.
|
||||
|
||||
> When using MySQL, make sure to append `?parseTime=true` to enable timestamp parsing.
|
||||
|
||||
- `username`: `(string: <required>)` -
|
||||
The username value to use when connecting to the database.
|
||||
@@ -1401,6 +1401,7 @@ snapshot began may or may not be included.
|
||||
"continuation": "2F1nUpUKMZUBnwQ77qByt1"
|
||||
}
|
||||
```
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
@@ -1448,7 +1449,6 @@ into an `exportable` mode store and vice versa.
|
||||
- `values` `([]string: <required>)` -
|
||||
Any number of tokenization state values from a previous snapshot call.
|
||||
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
@@ -1460,6 +1460,7 @@ into an `exportable` mode store and vice versa.
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
@@ -1514,6 +1515,7 @@ snapshot began may or may not be included.
|
||||
"continuation": "2F1nUpUKMZUBnwQ77qByt1"
|
||||
}
|
||||
```
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
@@ -1538,7 +1540,7 @@ $ curl \
|
||||
{
|
||||
"plaintext": "dmFsdWUtMg==",
|
||||
"token": "Q4tYgFXHxUNyMfqRW6fA82DYvMigwdf6JjATauyVzqx2SsmUShMhN5",
|
||||
"expiration_time": "2021-03-15T00:31:10Z",
|
||||
"expiration_time": "2021-03-15T00:31:10Z"
|
||||
},
|
||||
{
|
||||
"plaintext": "dmFsdWUtMQ==",
|
||||
@@ -1558,7 +1560,6 @@ new requests will be encoded with the new version of the key.
|
||||
| :----- | :---------------------------------------------------- |
|
||||
| `POST` | `/transform/tokenization/keys/:transform_name/rotate` |
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
- `transform_name` `(string: <required>)` –
|
||||
@@ -1596,13 +1597,13 @@ Only valid for tokenization transformations.
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
[
|
||||
```json
|
||||
[
|
||||
{
|
||||
"min_decryption_version": 1,
|
||||
"min_decryption_version": 1
|
||||
}
|
||||
]
|
||||
```
|
||||
]
|
||||
```
|
||||
|
||||
### Sample Request
|
||||
|
||||
@@ -1620,10 +1621,9 @@ List all tokenization keys.
|
||||
Only valid for tokenization transformations.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :------------------------------- |
|
||||
| :----- | :------------------------------ |
|
||||
| `LIST` | `/transform/tokenization/keys/` |
|
||||
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
@@ -1708,4 +1708,3 @@ $ curl \
|
||||
--data @payload.json \
|
||||
http://127.0.0.1:8200/v1/transform//transform/tokenization/keys/:transform_name/trim
|
||||
```
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: Transit - Secrets Engines - HTTP API
|
||||
sidebar_title: Transit
|
||||
description: This is the API documentation for the Vault Transit secrets engine.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/audit-hash - HTTP API
|
||||
sidebar_title: <code>/sys/audit-hash</code>
|
||||
description: |-
|
||||
The `/sys/audit-hash` endpoint is used to hash data using an audit device's
|
||||
hash function and salt.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/audit - HTTP API
|
||||
sidebar_title: <code>/sys/audit</code>
|
||||
description: The `/sys/audit` endpoint is used to enable and disable audit devices.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/auth - HTTP API
|
||||
sidebar_title: <code>/sys/auth</code>
|
||||
description: The `/sys/auth` endpoint is used to manage auth methods in Vault.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/capabilities-accessor - HTTP API
|
||||
sidebar_title: <code>/sys/capabilities-accessor</code>
|
||||
description: |-
|
||||
The `/sys/capabilities-accessor` endpoint is used to fetch the capabilities of
|
||||
the token associated with an accessor, on the given paths.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/capabilities-self - HTTP API
|
||||
sidebar_title: <code>/sys/capabilities-self</code>
|
||||
description: |-
|
||||
The `/sys/capabilities-self` endpoint is used to fetch the capabilities of
|
||||
client token on the given paths.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/capabilities - HTTP API
|
||||
sidebar_title: <code>/sys/capabilities</code>
|
||||
description: |-
|
||||
The `/sys/capabilities` endpoint is used to fetch the capabilities of a token
|
||||
on the given paths.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/config/auditing - HTTP API
|
||||
sidebar_title: <code>/sys/config/auditing</code>
|
||||
description: The `/sys/config/auditing` endpoint is used to configure auditing settings.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/config/control-group - HTTP API
|
||||
sidebar_title: <code>/sys/config/control-group</code>
|
||||
description: The '/sys/config/control-group' endpoint configures control groups.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/config/cors - HTTP API
|
||||
sidebar_title: <code>/sys/config/cors</code>
|
||||
description: >-
|
||||
The '/sys/config/cors' endpoint configures how the Vault server responds to
|
||||
cross-origin requests.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/config/state - HTTP API
|
||||
sidebar_title: <code>/sys/config/state</code>
|
||||
description: The '/sys/config/state' endpoint is used to retrieve the configuration state.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/config/ui - HTTP API
|
||||
sidebar_title: <code>/sys/config/ui</code>
|
||||
description: The '/sys/config/ui' endpoint configures the UI.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/control-group - HTTP API
|
||||
sidebar_title: <code>/sys/control-group</code>
|
||||
description: The '/sys/control-group' endpoint handles the Control Group workflow.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/generate-recovery-token - HTTP API
|
||||
sidebar_title: <code>/sys/generate-recovery-token</code>
|
||||
description: |-
|
||||
The `/sys/generate-recovery-token/` endpoints are used to create a new
|
||||
recovery token for Vault. They are only active in recovery mode.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/generate-root - HTTP API
|
||||
sidebar_title: <code>/sys/generate-root</code>
|
||||
description: |-
|
||||
The `/sys/generate-root/` endpoints are used to create a new root key for
|
||||
Vault.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/health - HTTP API
|
||||
sidebar_title: <code>/sys/health</code>
|
||||
description: The `/sys/health` endpoint is used to check the health status of Vault.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/host-info - HTTP API
|
||||
sidebar_title: <code>/sys/host-info</code>
|
||||
description: The '/sys/host-info' endpoint is used to retrieve host information
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: System Backend - HTTP API
|
||||
sidebar_title: System Backend
|
||||
description: |-
|
||||
The system backend is a default backend in Vault that is mounted at the `/sys`
|
||||
endpoint. This endpoint cannot be disabled or moved, and is used to configure
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/init - HTTP API
|
||||
sidebar_title: <code>/sys/init</code>
|
||||
description: The `/sys/init` endpoint is used to initialize a new Vault.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/internal/counters - HTTP API
|
||||
sidebar_title: <code>/sys/internal/counters</code>
|
||||
description: >-
|
||||
The `/sys/internal/counters` endpoints are used to return data about Vault usage.
|
||||
---
|
||||
@@ -245,7 +244,7 @@ Note: the client count may be inaccurate in the moments following a Vault reboot
|
||||
The estimate will stabilize when background loading of client data has completed.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :-------------------------------- |
|
||||
| :----- | :---------------------------------------- |
|
||||
| `GET` | `/sys/internal/counters/activity/monthly` |
|
||||
|
||||
### Sample Request
|
||||
@@ -268,7 +267,7 @@ $ curl \
|
||||
"data": {
|
||||
"distinct_entities": 100,
|
||||
"non_entity_tokens": 120,
|
||||
"clients": 220,
|
||||
"clients": 220
|
||||
},
|
||||
"wrap_info": null,
|
||||
"warnings": null,
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/internal/specs/openapi - HTTP API
|
||||
sidebar_title: <code>/sys/internal/specs/openapi</code>
|
||||
description: >-
|
||||
The `/sys/internal/specs/openapi` endpoint is used to generate an OpenAPI
|
||||
document of the mounted backends.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/internal/ui/feature-flags - HTTP API
|
||||
sidebar_title: <code>/sys/internal/ui/feature-flags</code>
|
||||
description: >-
|
||||
The `/sys/internal/ui/feature-flags` endpoint exposes feature flags to the UI.
|
||||
---
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/internal/ui/mounts - HTTP API
|
||||
sidebar_title: <code>/sys/internal/ui/mounts</code>
|
||||
description: >-
|
||||
The `/sys/internal/ui/mounts` endpoint is used to manage mount listing
|
||||
visibility.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/key-status - HTTP API
|
||||
sidebar_title: <code>/sys/key-status</code>
|
||||
description: |-
|
||||
The `/sys/key-status` endpoint is used to query info about the current
|
||||
encryption key of Vault.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/leader - HTTP API
|
||||
sidebar_title: <code>/sys/leader</code>
|
||||
description: |-
|
||||
The `/sys/leader` endpoint is used to check the high availability status and
|
||||
current leader of Vault.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/quotas/lease-count - HTTP API
|
||||
sidebar_title: <code>/sys/quotas/lease-count</code>
|
||||
description: The `/sys/quotas/lease-count` endpoint is used to create, edit and delete lease count quotas.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/leases - HTTP API
|
||||
sidebar_title: <code>/sys/leases</code>
|
||||
description: The `/sys/leases` endpoints are used to view and manage leases.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/license - HTTP API
|
||||
sidebar_title: <code>/sys/license</code>
|
||||
description: |-
|
||||
The `/sys/license` endpoint is used to view and update the license used in
|
||||
Vault.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/metrics - HTTP API
|
||||
sidebar_title: <code>/sys/metrics</code>
|
||||
description: The `/sys/metrics` endpoint is used to get telemetry metrics for Vault.
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/mfa/method/duo - HTTP API
|
||||
sidebar_title: <code>/sys/mfa/method/duo</code>
|
||||
description: >-
|
||||
The '/sys/mfa/method/duo' endpoint focuses on managing Duo MFA behaviors in
|
||||
Vault Enterprise.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/mfa - HTTP API
|
||||
sidebar_title: <code>/sys/mfa</code>
|
||||
description: >-
|
||||
The '/sys/mfa' endpoint focuses on managing MFA behaviors in Vault Enterprise
|
||||
MFA.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user