alexey.rassokhin/tet123
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

DBZ-8063 Add documentation for webhook auth config

Browse Source
This commit is contained in:
Timo Wilhelm 2024-07-15 16:02:16 +00:00 committed by Fiore Mario Vitale
parent 681db3ee03
commit 5603469755
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
documentation/modules/ROOT/pages/operations/debezium-server.adoc
View File

@ -798,7 +798,13 @@ optional https://en.wikipedia.org/wiki/JSON_Web_Token[JSON Web Token (JWT) authe
|[[httpclient-authentication-type]]<<httpclient-authentication-type, `debezium.sink.http.authentication.type` >>
|
|Specifies the authentication type to use. If missing, no authentication is used. Currently, only JSON Web Token (JWT) authentication (indicated by the value `jwt`) is supported.
|Specifies the type of authentication the HTTP client sink uses when connecting to an HTTP server.
Supports one of the following options:
`jwt`:: JSON Web Token (JWT) authentication.
`standard-webhooks`:: link:https://www.standardwebhooks.com/[Standard Webhooks].
If you omit this property, the HTTP client sink does not use authentication headers for the connection
|[[httpclient-authentication-jwt-username]]<<httpclient-authentication-jwt-username, `debezium.sink.http.authentication.jwt.username` >>
|
@ -820,6 +826,13 @@ optional https://en.wikipedia.org/wiki/JSON_Web_Token[JSON Web Token (JWT) authe
|
|Requested duration (in minutes) before the refresh token expires.
|[[httpclient-authentication-webhook-secret]]<<httpclient-authentication-webhook-secret, `debezium.sink.http.authentication.webhook.secret` >>
|
|The webhooks signing secret that {prodname} uses to generate HMAC-SHA256 signatures for the webhook request.
The secret must be Base64-encoded, with a size from 24 bytes to 64 bytes (192–512 bits).
Optionally, you can add the prefix `whsec_` to the secret to help distinguish it from other types of keys or tokens.
For more information about implementing or validating webhook signatures, see the link:https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md[Standard Webhooks specification].
|===