Skip to content

Conversation

@sandervandegeijn
Copy link
Contributor

Description

Document the new settings for basic auth for auditlog through a webhook.

Issues Resolved

opensearch-project/security#5792

Version

main

Frontend features

None

Add documentation for username and password configuration settings
that enable HTTP Basic Authentication for webhook audit log endpoints.
These settings are now supported for webhook sinks in addition to
external_opensearch sinks.

Signed-off-by: Sander van de Geijn <sandervandegeijn@icloud.com>
@github-actions
Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@kolchfa-aws
Copy link
Collaborator

@cwperks Could you review this PR?

@kolchfa-aws
Copy link
Collaborator

@sandervandegeijn What version is this for?

@kolchfa-aws kolchfa-aws added the Tech review PR: Tech review in progress label Dec 15, 2025
@sandervandegeijn
Copy link
Contributor Author

Good question, for whichever version the PR will get merged into (not in my control :) )

`plugins.security.audit.config.webhook.format` | String | The format in which the audit log message is logged, can be one of `URL_PARAMETER_GET`, `URL_PARAMETER_POST`, `TEXT`, `JSON`, `SLACK`. See [Formats](#formats).


### Basic auth settings
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The contents of this PR are good, but I think we can make these inline with the table above.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was in doubt, kept it together with the webhook section. Both are fine with me :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Tech review PR: Tech review in progress v-TBD

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants