Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport of Add available types to API documentation for enable audit into release/1.13.x #19853

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions website/content/api-docs/system/audit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,11 @@ single word name or a more complex, nested path.
- `description` `(string: "")` – Specifies a human-friendly description of the
audit device.

- `options` `(map<string|string>: nil)` – Specifies configuration options to
pass to the audit device itself. This is dependent on the audit device type.
- `options` `(map<string|string>: nil)` – Specifies configuration options to pass to the audit device itself.
For more details, please see the relevant page for an audit device `type`, under [Audit Devices docs](/vault/docs/audit).

- `type` `(string: <required>)` – Specifies the type of the audit device.
Valid types are `file`, `socket` and `syslog`.

Additionally, the following options are allowed in Vault open-source, but
relevant functionality is only supported in Vault Enterprise:
Expand Down