Skip to content

add Schema registry OAuth config #81

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.

Sign up for GitHub

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

Open
KyriosGN0 wants to merge 5 commits into
base: main
Choose a base branch
from
Open

add Schema registry OAuth config #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4ad2ff8
add Schema registry OAuth config
KyriosGN0 Apr 6, 2026
7da16d5
use only seconds
KyriosGN0 Apr 6, 2026
a87f207
update yaml config file
KyriosGN0 Apr 6, 2026
4eb5d22
Update configuration/configuration-file.md
KyriosGN0 Apr 17, 2026
4a5cbf7
update docs
KyriosGN0 Apr 17, 2026
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
10 changes: 10 additions & 0 deletions configuration/configuration-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,18 @@ kafka:
schemaRegistryShowNullValues: true # Show null fields in Avro messages (default: false)
schemaRegistryUseFullyQualifiedNames: true # Use full type names in unions (default: false)
schema-registry-auth:
# Basic authentication
username: schema registry username
password: schema registry password
# OAuth client-credentials authentication
oauth:
tokenUrl: https://auth.example.com/oauth/token
clientId: your-client-id
clientSecret: your-client-secret
scopes: schema-registry:read,schema-registry:write
tokenCacheEnabled: true # default: true
tokenRefreshBuffer: 60s # default: 60s
maxRetries: 1 # default: 1 (retries on 401 Unauthorized)
schema-registry-ssl:
keystore-location: path/to/keystore/file.jks
keystore-password: password
Expand Down
7 changes: 7 additions & 0 deletions configuration/misc-configuration-properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,13 @@ kafka:
| `KAFKA_CLUSTERS_0_SCHEMAREGISTRY` | SchemaRegistry's address |
| `KAFKA_CLUSTERS_0_SCHEMAREGISTRYAUTH_USERNAME` | SchemaRegistry's basic authentication username |
| `KAFKA_CLUSTERS_0_SCHEMAREGISTRYAUTH_PASSWORD` | SchemaRegistry's basic authentication password |
| `KAFKA_CLUSTERS_0_SCHEMAREGISTRYAUTH_OAUTH_TOKENURL` | Token URL for SchemaRegistry's OAuth client-credentials authentication. Cannot be combined with Basic auth on the same cluster. |
| `KAFKA_CLUSTERS_0_SCHEMAREGISTRYAUTH_OAUTH_CLIENTID` | Client ID for SchemaRegistry's OAuth authentication |
| `KAFKA_CLUSTERS_0_SCHEMAREGISTRYAUTH_OAUTH_CLIENTSECRET` | Client secret for SchemaRegistry's OAuth authentication |
| `KAFKA_CLUSTERS_0_SCHEMAREGISTRYAUTH_OAUTH_SCOPES` | Comma-separated list of OAuth scopes to request for SchemaRegistry authentication |
| `KAFKA_CLUSTERS_0_SCHEMAREGISTRYAUTH_OAUTH_TOKENCACHEENABLED` | Enable caching of OAuth tokens for SchemaRegistry. Default: `true` |
| `KAFKA_CLUSTERS_0_SCHEMAREGISTRYAUTH_OAUTH_TOKENREFRESHBUFFER` | Duration before token expiry to proactively refresh the token (e.g. `60s`, `360s`). Default: `60s` |
| `KAFKA_CLUSTERS_0_SCHEMAREGISTRYAUTH_OAUTH_MAXRETRIES` | Max number of retries on 401 Unauthorized responses from SchemaRegistry. Default: `1` |
| `KAFKA_CLUSTERS_0_SCHEMAREGISTRYSSL_KEYSTORELOCATION` | Path to the JKS keystore to communicate to SchemaRegistry |
| `KAFKA_CLUSTERS_0_SCHEMAREGISTRYSSL_KEYSTOREPASSWORD` | Password of the JKS keystore for SchemaRegistry |
| `KAFKA_CLUSTERS_0_SCHEMAREGISTRYSHOWNULLVALUES` | Show null fields in Avro messages instead of omitting them. Default: false |
Expand Down