Skip to content

Commit c3d87d5

Browse files
committed
fix incorrect suggestions
1 parent 9949987 commit c3d87d5

File tree

2 files changed

+18
-5
lines changed

2 files changed

+18
-5
lines changed

modules/manage/partials/authentication.adoc

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1676,21 +1676,26 @@ ifndef::env-kubernetes[]
16761676
rpk cluster config set http_authentication '["BASIC","OIDC"]'
16771677
----
16781678

1679-
To enable OIDC for HTTP API listeners, ensure the listeners allow OIDC authentication by setting xref:reference:properties/broker-properties.adoc#authentication_method[`authentication_method`] to `none` (which allows both Basic and OIDC authentication) or omitting it entirely (since `none` is the default). For example, in `redpanda.yaml`, enter:
1679+
To enable OIDC for HTTP API listeners, set xref:reference:properties/broker-properties.adoc#authentication_method[`authentication_method`] to `http_basic` to require authentication on those listeners. For example, in `redpanda.yaml`, enter:
16801680

16811681
[,yaml,lines=5+10]
16821682
----
16831683
pandaproxy:
16841684
pandaproxy_api:
16851685
- address: "localhost"
16861686
port: 8082
1687-
authentication_method: none # Allows both Basic and OIDC authentication
1687+
authentication_method: http_basic # Requires authentication (Basic or OIDC)
16881688
schema_registry:
16891689
schema_registry_api:
16901690
address: "localhost"
16911691
port: 8081
1692-
authentication_method: none # Allows both Basic and OIDC authentication
1692+
authentication_method: http_basic # Requires authentication (Basic or OIDC)
16931693
----
1694+
1695+
NOTE: The `authentication_method` broker property controls whether a listener requires authentication (`http_basic`) or allows anonymous access (`none`). The actual choice between Basic authentication and OIDC authentication is determined by:
1696+
1697+
1. What authentication methods are enabled in the xref:reference:properties/cluster-properties.adoc#http_authentication[`http_authentication`] cluster property
1698+
2. What type of Authorization header the client sends (`Basic` for Basic auth, `Bearer` for OIDC)
16941699
endif::[]
16951700

16961701
===== Connect to the HTTP API

modules/reference/pages/properties/broker-properties.adoc

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@ Replace the following placeholders with your values:
120120

121121
=== authentication_method
122122

123+
[[authentication_method]]
123124
Configures the authentication method for API endpoints. This property is set within each endpoint definition for the specific API listener.
124125

125126
*Visibility:* `user`
@@ -134,13 +135,20 @@ For Kafka API endpoints:
134135
- `mtls_identity` - Mutual TLS authentication using client certificates
135136

136137
For HTTP-based API endpoints (HTTP Proxy and Schema Registry):
137-
- `none` - No authentication required
138-
- `http_basic` - HTTP Basic authentication
138+
- `none` - No authentication required (allows anonymous access)
139+
- `http_basic` - Authentication required. The specific authentication method (Basic vs OIDC) depends on the xref:reference:properties/cluster-properties.adoc#http_authentication[`http_authentication`] cluster property and the client's Authorization header type.
139140

140141
*Default:* `none`
141142

142143
NOTE: The `authentication_method` property is defined within the endpoint configuration, not as a standalone property.
143144

145+
NOTE: This broker property works together with the cluster property xref:reference:properties/cluster-properties.adoc#http_authentication[`http_authentication`]:
146+
147+
* `authentication_method` (broker property): Controls whether a specific listener requires authentication (`http_basic`) or allows anonymous access (`none`)
148+
* `http_authentication` (cluster property): Controls which authentication methods are available globally (`["BASIC"]`, `["OIDC"]`, or `["BASIC", "OIDC"]`)
149+
150+
When `authentication_method: http_basic` is set on a listener, clients can use any authentication method that is enabled in the `http_authentication` cluster property.
151+
144152
When using `authentication_method: sasl`, you must also configure the available SASL mechanisms (such as SCRAM-SHA-256, SCRAM-SHA-512, SASL/PLAIN, GSSAPI, or OAUTHBEARER) using the xref:reference:properties/cluster-properties.adoc#sasl_mechanisms[`sasl_mechanisms`] cluster property.
145153

146154
.Kafka API authentication examples

0 commit comments

Comments
 (0)