Skip to content

Commit

Permalink
Update Vault Credential Library Docs with additional options (#3739) (#…
Browse files Browse the repository at this point in the history
…3751)

* Update Vault Credential Library Docs with additional Options

* Update credential-libraries.mdx

* docs: Minor copy edits

---------

Co-authored-by: Adam Bouhmad <[email protected]>
  • Loading branch information
Dan-Heath and AdamBouhmad authored Sep 19, 2023
1 parent fb22ccc commit cc08768
Showing 1 changed file with 8 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,17 @@ A credential library has the following configurable attributes:

The generic Vault credential library has the following additional attributes:

- `path` - (required) The path in Vault to request credentials from.
- `vault-path` - (required) The path in Vault to request credentials from.

- `http_method` - (optional) The HTTP method the library uses when requesting credentials from Vault.
- `credential-type` - (optional) The type of credential this library issues. The default value is `unspecified`.

- `credential-mapping-override` - (optional) If set, this value overrides the field attributes in the credential that is retrieved from Vault.

- `vault-http-method` - (optional) The HTTP method the library uses when it requests credentials from Vault.
Can be either `GET` or `POST`.
The default value is `GET`.

- `http_request_body` - (optional) The body of the HTTP request the library sends to Vault when requesting credentials.
- `vault-http-request-body` - (optional) The body of the HTTP request the library sends to Vault when it requests credentials.
Only valid if `http_method` is set to `POST`.

### Vault SSH certificate credential library attributes <sup>HCP/ENT</sup>
Expand All @@ -50,7 +54,7 @@ Alternatively, you could set the `session_connection_limit` to `1` for any targe

</Note>

- `path` - (required) The path in Vault to request credentials from.
- `vault-path` - (required) The path in Vault to request credentials from.

- `username` - (required) The username to use with the SSH certificate.
You can create a template for this value using [Vault credential library parameter templating](#vault-credential-library-parameter-templating).
Expand Down

0 comments on commit cc08768

Please sign in to comment.