Commit Graph

366 Commits

Author SHA1 Message Date
John-Michael Faircloth
f528036e45
docs: ldap secrets hierarchical paths (#27203)
* docs: ldap secrets hierarchical paths

* changelog

* Apply suggestions from code review

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* role_name => set_name

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2024-05-24 09:10:59 -05:00
Steven Clark
0bb3ddf7a7
Update cert metadata docs (#27025)
* Update cert metadata docs

 - Add missing enterprise notices on parameters and titles
 - Mention that the metadata parameter is a base64 encoded string
 - Tweak the no_store_metadata description
 - Update some entries within the PKI considerations page

* Add serial_number to read certificate metadata sample response

* Update fields sign-verbatim is affected by the specified role
2024-05-16 11:08:31 -04:00
Rowan Smith
7b51f6c866
[docs] add note around CRL rotation not occuring on revoke if auto_rebuild is enabled (#26893)
* add note around CRL rotation not occuring on revoke if auto_rebuild is enabled

A note to clarify that revocation will not trigger a rotation of the CRL if auto_rebuild of the CRL is set to true/enabled.

* fix links

fix links

* Update pki.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update pki.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2024-05-13 16:20:10 -04:00
Rachel Culpepper
70907cd971
Add docs for cert metadata (#26918)
* add new fields

* add new endpoint

* fix example

* fix description

* add header to sample request
2024-05-10 14:05:27 -05:00
Steven Clark
0637f5e316
PKI: Change sign-intermediate to truncate notAfter by default (behavior change) (#26796)
* PKI: Change sign-intermediate to truncate notAfter by default

 - The PKI sign-intermediate API allowed an end-user to request a TTL
   value that would extend beyond the signing issuer's notAfter. This would
   generate an invalid CA chain when properly validated.
 - We are now changing the default behavior to truncate the returned certificate
   to the signing issuer's notAfter.
 - End-users can get the old behavior by configuring the signing issuer's
   leaf_not_after_behavior field to permit, and call sign-intermediary
   with the new argument enforce_leaf_not_after_behavior to true. The
   new argument could also be used to enforce an error instead of truncating
   behavior if the signing issuer's leaf_not_after_behavior is set to err.

* Add cl

* Add cl and upgrade note

* Apply suggestions from code review

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2024-05-09 11:22:04 -04:00
Steven Clark
fe2b4c6f7a
PKI: Allow operators to increase the maximum TTL for ACME issued certificates (#26797)
* PKI: Allow operators to increase the maximum TTL for ACME issued certificates

* Add cl
2024-05-09 10:41:28 -04:00
Scott Miller
c4839ad05c
Document tokenization DELETE (#26622)
* Document tokenization DELETE

* typo

* Update website/content/api-docs/secret/transform.mdx

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>

---------

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>
2024-05-01 15:18:44 +00:00
Marc Boudreau
cd64c6e441
Fix heading level for Parameters in Identity/Group API doc page (#26621)
* change heading level for parameters to 3 from 2

* fixup! change heading level for parameters to 3 from 2
2024-04-30 14:59:26 -04:00
Rachel Culpepper
b49622076f
Add docs for cmac (#26654)
* add docs for cmac

* move cmac
2024-04-25 17:05:11 -05:00
Socheat Sok
f1922d2113
Minor tweak on "Set Certificate Chain" docs for Transit secret engine (#26250)
The `certificate_chain` parameter is incorrect from the description in the PR #21081.
2024-04-04 09:37:45 -04:00
radek-sprta
ab59f8fa56
Docs: Mention default_extensions_template in API docs (#26028)
Co-authored-by: Chris Capurso <1036769+ccapurso@users.noreply.github.com>
2024-03-19 11:06:51 -04:00
Hector Manuel
8ef273832e
Docs: New parameter for the Kubernetes Secrets roles (#25581)
* Docs: New parameter for the K8s Secrets roles

* Fix: Apply text correction from review

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
Co-authored-by: Peter Wilson <peter.wilson@hashicorp.com>
2024-03-13 18:27:30 +00:00
Austin Gebauer
57f7fa9c60
docs: adds enterprise documentation for plugin wif (#25706)
* docs: adds enterprise documentation for plugin wif

* attempt fix anchor link

* Update website/content/api-docs/secret/identity/tokens.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/docs/secrets/aws.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/docs/secrets/aws.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/docs/secrets/aws.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/docs/secrets/aws.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/docs/secrets/aws.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/docs/secrets/aws.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/secret/identity/tokens.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/secret/identity/tokens.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/docs/secrets/aws.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* remove API section for plugin WIF

* commas

* move wif out of subsection

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2024-03-07 19:14:30 -08:00
Steven Clark
43f8c7a6f0
PKI EST docs (#25521)
* PKI EST docs

 Initial draft of the PKI EST setup and API docs for feedback

* Add missing enable_sentinel_parsing param to API docs

* Update grammar

* Some API doc feedback

* Note about dedicated auth mounts

* Additional PR feedback

---------

Co-authored-by: Scott G. Miller <smiller@hashicorp.com>
2024-03-07 14:27:59 -05:00
Steven Clark
09294e891a
Add notes around OCSP GET request issue (#25745)
* Add note around OCSP GET request issue

 - Fix some broken TOC links
 - Add a note in the api-docs and in the considerations page
   around Vault having issues with OCSP GET requests and that
   POST requests should be preferred.
 - Add existing known issue to all branches that are affected.

* Fix links to partial file for 1.12 and 1.13 upgrade docs
2024-03-01 15:25:07 -05:00
Milena Zlaticanin
3a844a2e45
Update Azure secrets docs + deprecation (#25637)
* Update Azure secrets docs + deprecation

* add changelog

* update

* update docs

* update deprec doc
2024-02-28 11:59:00 -07:00
vinay-gopalan
60fb3c14d5
Add documentation for new Identity Token .well-known endpoint used for Plugin WIF (#25469) 2024-02-22 09:08:59 -08:00
vinay-gopalan
2dc73f0636
Add documentation for AWS Plugin WIF (#25398) 2024-02-21 09:19:43 -08:00
aphorise
6d59868fb8
Docs: Tranform secrets encode parameter: expiration added. (#25168)
* Docs: Tranform secrets encode parameter:  added.

* Docs: Tranform secrets encode parameter `expiration` text corrected & formating on `ttl` too.

* Docs: Tranform secrets encode parameter `expiration` formating & correction.

* Update website/content/api-docs/secret/transform.mdx
2024-02-02 10:20:10 -05:00
Austin Gebauer
677d98a821
oidc/provider: adds code_challenge_methods_supported to metadata (#24979)
* oidc/provider: adds code_challenge_methods_supported to metadata

* adds changelog

* adds docs
2024-01-22 13:40:13 -08:00
Nestor Reyes
4811fd1962
Update oracle.mdx missing feature flags (#23517)
* Update oracle.mdx missing feature flags

Adding missing feature flags to API doc. 
split_statements and disconnect_sessions.

Related PR
https://github.com/hashicorp/vault-plugin-database-oracle/pull/62

* Update website/content/api-docs/secret/databases/oracle.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2024-01-22 13:59:04 -06:00
Andy Assareh
ab2e0e5a28
typo corrections - spelling and grammar (#24625)
* typo corrections - spelling

* spelling and grammar
2024-01-04 12:50:42 -05:00
Tom Proctor
dc5c3e8d97
New database plugin API to reload by plugin name (#24472) 2023-12-13 10:23:34 +00:00
Steven Clark
a41852379b
Document and augment tests that PKI accepts 8192 bit RSA keys (#24364)
- Noticed that our documentation was out of date, we allow 8192
   bit RSA keys to be used as an argument to the various PKI
   issuer/key creation APIs.
 - Augument some unit tests to verify this continues to work
2023-12-05 15:26:03 -05:00
Milena Zlaticanin
aa9b02307d
Update Azure Secrets docs (#24279) 2023-12-04 15:41:25 -07:00
Steven Clark
53040690a2
PKI: Do not set NextUpdate OCSP field when ocsp_expiry is 0 (#24192)
* Do not set NextUpdate OCSP field when ocsp_expiry is 0

* Add cl
2023-11-20 10:32:05 -05:00
Robert
54bf0807c1
secrets/aws: add support for STS Session Tokens with TOTP (#23690)
* Add test coverage

* Add session_token field, deprecate security_token

* Undo auth docs

* Update api docs

* Add MFA code support

---------

Co-authored-by: Graham Christensen <graham@grahamc.com>
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
Co-authored-by: Austin Gebauer <34121980+austingebauer@users.noreply.github.com>
2023-11-08 17:06:28 -06:00
kpcraig
dd15e5296f
Add documentation for new ldap param (#23817) 2023-11-01 11:33:53 -04:00
Steven Clark
8c9929bed2
Update specifics around managed keys support in Transit (#23795) 2023-10-26 13:45:15 -04:00
Andreas Gruhler
548b7a094b
Fix backticks for cluster_aia_path (#23845) 2023-10-26 08:28:16 -04:00
kpcraig
30f19b383f
VAULT-18307: update rotation period for aws static roles on update (#23528) 2023-10-11 17:06:58 +00:00
Skybladev2
6ff9fcabab
Fix path for Delete metadata and all versions (#23542)
* Fix path for Delete metadata and all versions

* fix template - remove unneeded trailing double colon
2023-10-09 13:05:49 -07:00
Nicola Kabar
2a46d492a3
updated the LIST identity/entity-alias/id endpoint docs (#23016)
* updated the LIST identity/entity-alias/id endpoint docs to reflect new data returned

* Update website/content/api-docs/secret/identity/entity-alias.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/secret/identity/entity-alias.mdx

Co-authored-by: Max Bowsher <maxbowsher@gmail.com>

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
Co-authored-by: Max Bowsher <maxbowsher@gmail.com>
2023-09-18 12:30:30 -07:00
Raymond Ho
018e5675fe
VAULT 18227/introduce cap ldap library (#22185) 2023-09-14 10:26:29 -07:00
Alexander Scheel
21742020f0
Add API docs on Transit X.509 certificates (#22998)
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
2023-09-12 11:35:37 -04:00
vinay-gopalan
2b74a4826b
Add documentation for IAM authentication for DB Secrets Engine (#22836)
Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
2023-09-08 14:03:50 -07:00
John-Michael Faircloth
1870018090
docs: db schedule-based static role rotations (#22863)
* docs: db schedule-based static role rotations

* fix broken link

* add mutual exclusion notice on overview page

* prepend slash to relative link
2023-09-07 16:50:57 -05:00
Steven Clark
aa81aeaba0
Add api-docs for PKI CIEPS sign-intermediate (#22371)
* Add api-docs for PKI CIEPS sign-intermediate

 - This adds the CIEPS sign-intermediate api-docs and tweaks the existing CIEPS apis to mark the policy url argument as optional.

* Define CIEPS in the first use per section
2023-08-17 08:57:55 -04:00
Chip Stepowski
f0c66d4e26
Add metadata policy requirement for KV-V2 list.mdx (#21812)
* Add metadata policy requirement for KV-V2 list.mdx

Customer requested change as our API docs page does not state the token policy must have access to metadata in the policy when listing KV-V2 secrets. I let them know it exists here: https://developer.hashicorp.com/vault/docs/secrets/kv/kv-v2#acl-rules, in the ACL section, but they wanted to have it added to the API docs as well.

* Update website/content/api-docs/secret/kv/kv-v2.mdx

---------

Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com>
2023-08-15 13:51:44 -04:00
Sarah Chavis
91face4eff
convert OSS language to "community" (#22343) 2023-08-15 13:31:52 -04:00
Alexander Scheel
d4e402d597
Docs CIEPS Configuration (#22259)
* Clarify wording, add missing expiration fields

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add API docs on CIEPS configuration

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Fix ToC, headers to include EnterpriseAlert

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Update website/content/api-docs/secret/pki.mdx

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>

* Update website/content/api-docs/secret/pki.mdx

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>

---------

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
Co-authored-by: Steven Clark <steven.clark@hashicorp.com>
2023-08-09 09:27:06 -04:00
Alexander Scheel
04a081226d
Add docs on CIEPS issuance (#22098)
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
2023-08-09 08:01:17 -04:00
John-Michael Faircloth
a1a5be97e2
docs/db: fix outdated static role information (#22239) 2023-08-08 11:02:53 -05:00
Sarah Chavis
b6d973a133
Make enterprise callouts consistent (#22073) 2023-07-27 17:41:14 +00:00
Laurent
366693c78d
Add a parameter to allow ExtKeyUsage field usage from a role within ACME (#21702)
* imprv: Add a parameter to allow ExtKeyUsage field usage from a role

* chore: Add the changelog entry

* imprv: Reword UI and changelog

* doc: Add allow_role_extkeyusage in parameter list

* imprv: Align variable names with existing fields/codebase

* Add unit test and tweak some labels

---------

Co-authored-by: Steve Clark <steven.clark@hashicorp.com>
2023-07-17 09:31:13 -04:00
Anton Averchenkov
f4f0412b6a
[docs] Convert titles to sentense case (#21426)
* Convert documentation titles to sentense case

* Docker, Google, Foundry, Cloud proper case
2023-06-30 19:22:07 -04:00
Max Bowsher
43ae739971
Refactor identity/mfa/method/* endpoints to fix bad OpenAPI (#20879)
* Refactor `identity/mfa/method/*` endpoints to fix bad OpenAPI

There is a problem with how the `identity/mfa/method/*` endpoints are
defined, resulting in incorrect OpenAPI generation.

I raised hashicorp/vault-client-go#180 to track a consequence, and
opened #20873 which explains the problem and adds a log message to
detect it.

This PR is now the fix.

It's actually quite an interesting problem, that has come about through
some particular implementation choices, in Vault's first/only case where
REST API objects are created by writing to the collection URL, and have
their ID allocated by the server, instead of the client.

The triggering cause of the malfunction was trying to have a single
framework.Path struct instance which optionally includes or excludes the
method_id path parameter, and also another framework.Path struct
instance handling list operations.

The fix is to simplify the path regexes, and have one framework.Path
which handles the method_id being present, and one that handles it being
absent.

The diff is somewhat large, because the affected code had been
copy/pasted four times (TOTP, Okta, Duo, PingID) - so I took the
opportunity to fix the duplication, creating appropriate helper methods
so that the quadruplicated code could be re-unified.

* Revise documentation

This update refactors how the documentation presents these endpoints to
users, both for clarity, and to align with the new structure of the
code.

From a user perspective, it clears up some unclear presentation of when
the `method_id` parameter should and should not be present, adds
a missing description of the response to create requests, and changes
the `method_id` parameter name to be used consistently (rather than `id`
in some cases, unlike the actual code/OpenAPI).

* Fix incorrect acronym (review fix)

* Accept suggestion of tweaked grammar in documentation

Co-authored-by: Anton Averchenkov <84287187+averche@users.noreply.github.com>

* Add changelog

---------

Co-authored-by: Anton Averchenkov <84287187+averche@users.noreply.github.com>
2023-06-23 13:32:41 -04:00
Violet Hynes
8e40823fe1
Some small KV API docs improvements (#21395) 2023-06-22 13:39:47 -04:00
Steven Clark
eb634e9326
Remove bump_version from transit import docs (#21393)
- The argument was removed along the development path, but the
   documentation was not updated.
2023-06-21 15:36:52 -04:00
Alexander Scheel
3347e5d56b
Fix naming of enable_templating parameter (#21319)
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
2023-06-16 17:04:37 +00:00