Skip to content

chore(docs): Fix wrong examples due to incorrect grant types #189

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

Merged
adutra merged 1 commit into from
Sep 30, 2025
Merged

chore(docs): Fix wrong examples due to incorrect grant types #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ The effective subject token fetch configuration will be the result of merging th
Example:

```
rest.auth.oauth2.grant-type=token_exchange
rest.auth.oauth2.grant-type=urn:ietf:params:oauth:grant-type:token-exchange
rest.auth.oauth2.token-endpoint=https://main-token-endpoint.com/token
rest.auth.oauth2.client-id=main-client-id
rest.auth.oauth2.client-secret=main-client-secret
Expand All @@ -366,7 +366,7 @@ The effective actor token fetch configuration will be the result of merging the
Example:

```
rest.auth.oauth2.grant-type=token_exchange
rest.auth.oauth2.grant-type=urn:ietf:params:oauth:grant-type:token-exchange
rest.auth.oauth2.token-endpoint=https://main-token-endpoint.com/token
rest.auth.oauth2.client-id=main-client-id
rest.auth.oauth2.client-secret=main-client-secret
Expand Down
15 changes: 8 additions & 7 deletions docs/token-exchange.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ rest.auth.type=com.dremio.iceberg.authmgr.oauth2.OAuth2Manager

# Basic settings
rest.auth.oauth2.issuer-url=https://$PRIMARY_IDP/realms/primary
rest.auth.oauth2.grant-type=token_exchange
rest.auth.oauth2.grant-type=urn:ietf:params:oauth:grant-type:token-exchange
rest.auth.oauth2.client-id=Client1
rest.auth.oauth2.client-secret=$CLIENT1_SECRET
rest.auth.oauth2.scope=catalog1
Expand Down Expand Up @@ -103,22 +103,23 @@ rest.auth.type=com.dremio.iceberg.authmgr.oauth2.OAuth2Manager

# Basic settings
rest.auth.oauth2.issuer-url=https://$PRIMARY_IDP/realms/primary
rest.auth.oauth2.grant-type=token_exchange
rest.auth.oauth2.grant-type=urn:ietf:params:oauth:grant-type:token-exchange
rest.auth.oauth2.client-id=Client1
rest.auth.oauth2.client-secret=$CLIENT1_SECRET
rest.auth.oauth2.scope=catalog1

# Subject token settings
rest.auth.oauth2.token-exchange.subject-token.issuer-url=https://$SECONDARY_IDP/realms/secondary
rest.auth.oauth2.token-exchange.subject-token.grant-type=device_code
rest.auth.oauth2.token-exchange.subject-token.grant-type=urn:ietf:params:oauth:grant-type:device_code
rest.auth.oauth2.token-exchange.subject-token.client-id=Client2
rest.auth.oauth2.token-exchange.subject-token.client-secret=$CLIENT2_SECRET
rest.auth.oauth2.token-exchange.subject-token.scope=catalog2
```

In this example, the subject token is obtained from a secondary IDP using the `device_code` grant
type, thus allowing the user to authenticate with their own identity. The primary IDP is then used
to exchange the subject token for an access token using the token exchange grant type.
In this example, the subject token is obtained from a secondary IDP using the
`urn:ietf:params:oauth:grant-type:device_code` grant type, thus allowing the user to authenticate
with their own identity. The primary IDP is then used to exchange the subject token for an access
token using the token exchange grant type.

Here is a more complex example of how to configure the AuthManager to fetch both the subject and
actor tokens:
Expand All @@ -128,7 +129,7 @@ rest.auth.type=com.dremio.iceberg.authmgr.oauth2.OAuth2Manager

# Basic settings
rest.auth.oauth2.issuer-url=https://$PRIMARY_IDP/realms/primary
rest.auth.oauth2.grant-type=token_exchange
rest.auth.oauth2.grant-type=urn:ietf:params:oauth:grant-type:token-exchange
rest.auth.oauth2.client-id=Client1
rest.auth.oauth2.client-secret=$CLIENT1_SECRET
rest.auth.oauth2.scope=catalog1
Expand Down
4 changes: 2 additions & 2 deletions oauth2/core/src/main/java/com/dremio/iceberg/authmgr/oauth2/config/TokenExchangeConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ public interface TokenExchangeConfig {
* <p>Example:
*
* <pre>{@code
* rest.auth.oauth2.grant-type=token_exchange
* rest.auth.oauth2.grant-type=urn:ietf:params:oauth:grant-type:token-exchange
* rest.auth.oauth2.token-endpoint=https://main-token-endpoint.com/token
* rest.auth.oauth2.client-id=main-client-id
* rest.auth.oauth2.client-secret=main-client-secret
Expand Down Expand Up @@ -149,7 +149,7 @@ public interface TokenExchangeConfig {
* <p>Example:
*
* <pre>{@code
* rest.auth.oauth2.grant-type=token_exchange
* rest.auth.oauth2.grant-type=urn:ietf:params:oauth:grant-type:token-exchange
* rest.auth.oauth2.token-endpoint=https://main-token-endpoint.com/token
* rest.auth.oauth2.client-id=main-client-id
* rest.auth.oauth2.client-secret=main-client-secret
Expand Down