Skip to content

Commit 09a3846

Browse files
committed
refactor auth options in doc
1 parent 136a7be commit 09a3846

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

mkdocs/docs/configuration.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -340,12 +340,8 @@ catalog:
340340
| Key | Example | Description |
341341
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------- |
342342
| uri | <https://rest-catalog/ws> | URI identifying the REST Server |
343-
| ugi | t-1234:secret | Hadoop UGI for Hive client. |
344-
| scope | openid offline corpds:ds:profile | Desired scope of the requested security token (default : catalog) |
345-
| resource | rest_catalog.iceberg.com | URI for the target resource or service |
346-
| audience | rest_catalog | Logical name of target resource or service |
347-
| snapshot-loading-mode | refs | The snapshots to return in the body of the metadata. Setting the value to `all` would return the full set of snapshots currently valid for the table. Setting the value to `refs` would load all snapshots referenced by branches or tags. |
348343
| warehouse | myWarehouse | Warehouse location or identifier to request from the catalog service. May be used to determine server-side overrides, such as the warehouse location. |
344+
| snapshot-loading-mode | refs | The snapshots to return in the body of the metadata. Setting the value to `all` would return the full set of snapshots currently valid for the table. Setting the value to `refs` would load all snapshots referenced by branches or tags. |
349345
| `header.X-Iceberg-Access-Delegation` | `vended-credentials` | Signal to the server that the client supports delegated access via a comma-separated list of access mechanisms. The server may choose to supply access via any or none of the requested mechanisms. When using `vended-credentials`, the server provides temporary credentials to the client. When using `remote-signing`, the server signs requests on behalf of the client. (default: `vended-credentials`) |
350346

351347

@@ -364,19 +360,23 @@ catalog:
364360

365361

366362
#### Authentication Options
367-
- **SigV4**: For AWS services that require SigV4 signing.
368-
- **OAuth2**: For services that require OAuth2 authentication.
369-
- **Bearer Token**: Use the `token` property to pass a bearer token directly for services that accept token-based authentication.
370-
- **Client Credentials**: Use the `credential` property with the format `client_id:client_secret` to perform the OAuth2 client credentials flow. Optionally, use the `oauth2-server-uri` property to specify a custom OAuth2 endpoint for client credentials authentication.
371363

364+
##### OAuth2
365+
| Key | Example | Description |
366+
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------- |
367+
| token | FEW23.DFSDF.FSDF | Bearer token value to use for `Authorization` header |
368+
| oauth2-server-uri | <https://auth-service/cc> | Authentication URL to use for client credentials authentication (default: uri + 'v1/oauth/tokens') |
369+
| credential | client_id:client_secret | Credential to use for OAuth2 credential flow when initializing the catalog |
370+
| scope | openid offline corpds:ds:profile | Desired scope of the requested security token (default : catalog) |
371+
| resource | rest_catalog.iceberg.com | URI for the target resource or service |
372+
| audience | rest_catalog | Logical name of target resource or service |
373+
374+
##### SigV4
372375
| Key | Example | Description |
373376
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------- |
374377
| rest.sigv4-enabled | true | Sign requests to the REST Server using AWS SigV4 protocol |
375378
| rest.signing-region | us-east-1 | The region to use when SigV4 signing a request |
376379
| rest.signing-name | execute-api | The service signing name to use when SigV4 signing a request |
377-
| oauth2-server-uri | <https://auth-service/cc> | Authentication URL to use for client credentials authentication (default: uri + 'v1/oauth/tokens') |
378-
| token | FEW23.DFSDF.FSDF | Bearer token value to use for `Authorization` header |
379-
| credential | t-1234:secret | Credential to use for OAuth2 credential flow when initializing the catalog |
380380

381381
<!-- markdown-link-check-enable-->
382382

0 commit comments

Comments
 (0)