This is an automated email from the ASF dual-hosted git repository.
lhotari pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new 78efd1ea446 oauth2 authentication truststore and timeouts (#1052)
78efd1ea446 is described below
commit 78efd1ea446503e6ba3f24edc5ad26b35993c1f2
Author: gulecroc <[email protected]>
AuthorDate: Mon Dec 1 09:14:51 2025 +0100
oauth2 authentication truststore and timeouts (#1052)
* oauth2 authentication truststore and timeouts
* update timeouts format
---
docs/security-oauth2.md | 3 +++
1 file changed, 3 insertions(+)
diff --git a/docs/security-oauth2.md b/docs/security-oauth2.md
index 725c83cc1df..d438ab2d092 100644
--- a/docs/security-oauth2.md
+++ b/docs/security-oauth2.md
@@ -236,6 +236,9 @@ The following table outlines the parameters of the
`client_credentials` authenti
| `privateKey` | The URL to the JSON credentials file. | Support the
following pattern formats: <br /> <li> `file:///path/to/file`
</li><li>`file:/path/to/file` </li><li>
`data:application/json;base64,<base64-encoded value>` </li>| Required |
| `audience` | The OAuth 2.0 "resource server" identifier for a Pulsar
cluster. | `https://broker.example.com` | Optional |
| `scope` | The scope of an access request. <br />For more information, see
[access token
scope](https://datatracker.ietf.org/doc/html/rfc6749#section-3.3). |
api://pulsar-cluster-1/.default | Optional |
+| `connectTimeout` | The HTTP connection timeout with
[java.time.Duration](https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence))
format. Default value: `PT10S`. Only implemented in java client. | PT10S |
Optional |
+| `readTimeout` | The HTTP read timeout with
[java.time.Duration](https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence))
format. Default value: `PT30S`. Only implemented in java client. | PT30S |
Optional |
+| `trustCertsFilePath` | The path to the file containing the trusted
certificate(s) of the token issuer. If not set, uses the default trust store of
the JVM. Only implemented in java client. | /path/to/file | Optional |
The credentials file `credentials_file.json` contains the service account
credentials used with the client authentication type. The following is an
example of the credentials file. The authentication type is set to
`client_credentials` by default. And the fields "client_id" and "client_secret"
are required.