Skip to content

DOC: Add REST catalog authentication properties documentation #14143

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

Closed
kuldeep27396 wants to merge 3 commits into from
Closed

DOC: Add REST catalog authentication properties documentation #14143

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5d63824
DOC: Add REST catalog authentication properties documentation
kuldeep27396 Sep 21, 2025
cccfebf
Update docs/docs/configuration.md
kuldeep27396 Sep 22, 2025
bb153a2
Update docs/docs/configuration.md
kuldeep27396 Sep 22, 2025
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
20 changes: 20 additions & 0 deletions docs/docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,3 +198,23 @@ is available on the Hive Metastore server, if it is backed by MySQL or MariaDB
Even with `iceberg.engine.hive.lock-enabled` set to `false`, a HiveCatalog can still use locks for individual tables by setting the table property `engine.hive.lock-enabled`=`true`.
This is useful in the case where other HiveCatalogs cannot be upgraded and set to commit without using Hive locks.

## REST catalog authentication properties

The REST catalog supports multiple authentication mechanisms to secure access to catalog operations. These properties are used to configure authentication for REST catalog clients.

| Property | Default | Description |
| --------------------------------- | ------------------ | ------------------------------------------------------ |
| rest.auth.type | null | Authentication type: `none`, `basic`, `oauth2`, `sigv4`, `google` |
| rest.auth.basic.username | null | Username for basic authentication |
| rest.auth.basic.password | null | Password for basic authentication |
| oauth2-server-uri | null | OAuth2 server URI for token endpoint |
| token | null | Bearer token for OAuth2 authentication |
| credential | null | Credential to exchange for OAuth2 token |
| token-expires-in-ms | 3600000 (1 hour) | Token expiration time in milliseconds |
| token-refresh-enabled | true | Whether to refresh tokens when expiration info is available |
| token-exchange-enabled | true | Whether to use token exchange for acquiring new tokens |
| scope | null | Additional scope for OAuth2 |
| audience | null | Optional audience parameter for OAuth2 |
| resource | null | Optional resource parameter for OAuth2 |
| rest.auth.sigv4.delegate-auth-type| oauth2 | Delegate auth type for SigV4 authentication |

Copy link
Copy Markdown
Contributor

@nastra nastra Sep 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For google we need to also document these:

iceberg/gcp/src/main/java/org/apache/iceberg/gcp/auth/GoogleAuthManager.java

Lines 56 to 57 in 40c0a73

public static final String GCP_CREDENTIALS_PATH_PROPERTY = "gcp.auth.credentials-path";
public static final String GCP_SCOPES_PROPERTY = "gcp.auth.scopes";

Copy link
Copy Markdown
Contributor

@nastra nastra Sep 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In fact I would probably extract this into its own small table that is specific to google. Then we should do the same for oauth2 and the other auth types