You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| uri | <https://rest-catalog/ws> | URI identifying the REST Server |
342
+
| uri | <https://rest-catalog/ws> | URI identifying the REST Server |
343
343
| ugi | t-1234:secret | Hadoop UGI for Hive client. |
344
-
| credential | t-1234:secret | Credential to use for OAuth2 credential flow when initializing the catalog |
345
-
| token | FEW23.DFSDF.FSDF | Bearer token value to use for `Authorization` header |
346
344
| scope | openid offline corpds:ds:profile | Desired scope of the requested security token (default : catalog) |
347
345
| resource | rest_catalog.iceberg.com | URI for the target resource or service |
348
346
| audience | rest_catalog | Logical name of target resource or service |
349
-
| rest.sigv4-enabled | true | Sign requests to the REST Server using AWS SigV4 protocol |
350
-
| rest.signing-region | us-east-1 | The region to use when SigV4 signing a request |
351
-
| rest.signing-name | execute-api | The service signing name to use when SigV4 signing a request |
352
-
| oauth2-server-uri | <https://auth-service/cc> | Authentication URL to use for client credentials authentication (default: uri + 'v1/oauth/tokens') |
353
-
| 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. |
354
-
| 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. |
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. |
348
+
| 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. |
349
+
| `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`) |
355
350
356
-
<!-- markdown-link-check-enable-->
357
351
358
352
#### Headers in RESTCatalog
359
353
@@ -368,21 +362,28 @@ catalog:
368
362
header.content-type: application/vnd.api+json
369
363
```
370
364
371
-
Specific headers defined by the RESTCatalog spec include:
| `header.X-Iceberg-Access-Delegation` | `{vended-credentials,remote-signing}` | `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. |
376
365
377
366
#### Authentication Options
378
367
- **SigV4**: For AWS services that require SigV4 signing.
379
-
- **Token**: Use the `token` property to pass a bearer token for services that accept token-based authentication.
380
-
- **Credential**: Use the `credential` property with format `client_id:client_secret` for authentication.
381
-
- **OAuth2**: Use the `oauth2-server-uri` property to specify a custom OAuth2 endpoint for client credentials authentication.
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.
0 commit comments