eric-maynard commented on code in PR #2315: URL: https://github.com/apache/polaris/pull/2315#discussion_r2274320263
########## site/content/in-dev/unreleased/getting-started/using-polaris.md: ########## @@ -285,6 +285,51 @@ SELECT * FROM iceberg.quickstart_schema.quickstart_table; org.apache.iceberg.exceptions.ForbiddenException: Forbidden: Principal 'quickstart_user' with activated PrincipalRoles '[]' and activated grants via '[quickstart_catalog_role, quickstart_user_role]' is not authorized for op LOAD_TABLE_WITH_READ_DELEGATION ``` +### Connecting with PyIceberg + +#### Using Credentials + +```python +from pyiceberg.catalog import load_catalog + +catalog = load_catalog( + type='rest', + uri='http://localhost:8181/api/catalog', + warehouse='quickstart_catalog', + scope="PRINCIPAL_ROLE:ALL", + credential=f"{CLIENT_ID}:{CLIENT_SECRET}", +) +``` + +If the `load_catalog` function is used with credentials, then PyIceberg will automatically request an authorization token from the `v1/oauth/tokens` endpoint, and will later use this token to prove its identity to the Polaris Catalog. + +#### Using a Token + +```python +from pyiceberg.catalog import load_catalog +import requests + +# Step 1: Get OAuth token +response = requests.post( + "http://localhost:8181/api/catalog/v1/oauth/tokens";, + auth =(CLIENT_ID, CLIENT_SECRET), + data = { + "grant_type": "client_credentials", + "scope": "PRINCIPAL_ROLE:ALL" + }) +token = response.json()["access_token"] + +# Step 2: Load the catalog using the token +catalog = load_catalog( + type='rest', + uri='http://localhost:8181/api/catalog', + warehouse='quickstart_catalog', + token=token, +) +``` + +It is possible to use `load_catalog` function by providing an authorization token directly. This method is useful when using an external identity provider (e.g. Google Identity). + Review Comment: eh, the other sections for other clients doesn't get into too much detail either -- it could be nice to have, but I think a regtest would be even better to cover a full set of operations in pyiceberg. The docs can stay lightweight -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@polaris.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
