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
Copy file name to clipboardExpand all lines: docs/docs/configuration.md
+37Lines changed: 37 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -143,6 +143,43 @@ The properties can be manually constructed or passed in from a compute engine li
143
143
Spark uses its session properties as catalog properties, see more details in the [Spark configuration](spark-configuration.md#catalog-configuration) section.
144
144
Flink passes in catalog properties through `CREATE CATALOG` statement, see more details in the [Flink](flink.md#adding-catalogs) section.
145
145
146
+
### REST Catalog auth properties
147
+
148
+
The following catalog properties configure authentication for the REST catalog.
149
+
They support Basic, OAuth2, SigV4, and Google authentication.
|`token`| null | A Bearer token to interact with the server. Either `token` or `credential` is required. |
166
+
|`credential`| null | Credential string in the form of `client_id:client_secret` to exchange for a token in the OAuth2 client credentials flow. Either `token` or `credential` is required. |
167
+
|`oauth2-server-uri`|`v1/oauth/tokens`| OAuth2 token endpoint URI. Required if the REST catalog is not the OAuth2 authentication server. |
168
+
|`token-expires-in-ms`| 3600000 (1 hour) | Time in milliseconds after which a bearer token is considered expired. Used to decide when to refresh or re-exchange a token. |
169
+
|`token-refresh-enabled`| true | Determines whether tokens are automatically refreshed when expiration details are available. |
170
+
|`token-exchange-enabled`| true | Determines whether to use the token exchange flow to acquire new tokens. Disabling this will allow fallback to the client credential flow. |
171
+
|`scope`|`catalog`| Additional scope for `oauth2`. |
172
+
|`audience`| null | Optional param to specify token `audience`|
173
+
|`resource`| null | Optional param to specify `resource`|
174
+
175
+
#### Google auth properties
176
+
Required and optional properties to include while using `google` authentication
0 commit comments