You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@iceberg.apache.org by "sungwy (via GitHub)" <gi...@apache.org> on 2025/06/16 13:51:06 UTC
Re: [PR] [#13209] Docs site: adding configuration table for REST catalog auth [iceberg]
sungwy commented on code in PR #13256:
URL: https://github.com/apache/iceberg/pull/13256#discussion_r2150056778
##########
docs/docs/configuration.md:
##########
@@ -143,6 +143,21 @@ The properties can be manually constructed or passed in from a compute engine li
Spark uses its session properties as catalog properties, see more details in the [Spark configuration](spark-configuration.md#catalog-configuration) section.
Flink passes in catalog properties through `CREATE CATALOG` statement, see more details in the [Flink](flink.md#adding-catalogs) section.
+### Catalog REST auth properties
+
+Below are the properties used to configure authentication for the REST catalog. These properties allow you to set up basic or OAuth2 authentication for accessing the REST catalog.
+
+| Property | Default | Description |
+| --------------------------------- | ------------------ | ------------------------------------------------------ |
+| rest.auth.type | none | Type of authorization to use for REST catalog access. One of `none`, `basic`, `oauth2` or `sigv4`. |
+| rest.auth.basic.username | null | Username for basic authorization. Required if `rest.auth.type` is `basic`. |
+| rest.auth.basic.password | null | Password for basic authorization. Required if `rest.auth.type` is `basic`. |
+| rest.auth.credential | null | A credential to exchange for a token in the OAuth2 client credentials flow. Required if `rest.auth.type` is `oauth2`. |
+| rest.auth.oauth2-server-uri | null | Token endpoint URI to fetch token from if the Rest Catalog is not the authorization server. Required if `rest.auth.type` is `oauth2`. |
+| rest.auth.token-expires-in-ms | 3600000 (1 hour) | The time in milliseconds after which the OAuth2 token expires. Used to determine when to refresh the token. Defaults to 1 hour. |
Review Comment:
```suggestion
| --------------------------------- | ------------------ | ------------------------------------------------------ |
| rest.auth.type | none | Type of authentication to use for REST catalog access. One of `none`, `basic`, `oauth2` or `sigv4`. |
| rest.auth.basic.username | null | Username for basic authentication. Required if `rest.auth.type` is `basic`. |
| rest.auth.basic.password | null | Password for basic authentication. Required if `rest.auth.type` is `basic`. |
| rest.auth.credential | null | A credential to exchange for a token in the OAuth2 client credentials flow. Required if `rest.auth.type` is `oauth2`. |
| rest.auth.oauth2-server-uri | null | Token endpoint URI to fetch token from if the Rest Catalog is not the authentication server. Required if `rest.auth.type` is `oauth2`. |
| rest.auth.token-expires-in-ms | 3600000 (1 hour) | The time in milliseconds after which the OAuth2 token expires. Used to determine when to refresh the token. Defaults to 1 hour. |
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org