Skip to content

Commit 72286b8

Browse files
Merge pull request #716 from pyathena-dev/docs/jwt-tip-limitation
docs: note JWT Trusted Identity Propagation is not supported
2 parents 7a6326f + ebcc36d commit 72286b8

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

docs/usage.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -609,3 +609,16 @@ from pyathena import connect
609609
cursor = connect(s3_staging_dir="s3://YOUR_S3_BUCKET/path/to/",
610610
region_name="us-west-2").cursor()
611611
```
612+
613+
### Unsupported: JWT Trusted Identity Propagation
614+
615+
Amazon Athena supports [JWT-based Trusted Identity Propagation (TIP)](https://docs.aws.amazon.com/athena/latest/ug/security-iam-trusted-identity-propagation.html) for the official **JDBC and ODBC drivers**, allowing enterprise SSO identities (Okta, Entra ID, etc.) to be propagated to Athena and Lake Formation for fine-grained access control.
616+
617+
**PyAthena does not support JWT TIP**, because this auth flow is not exposed through the AWS SDK (`boto3` / `botocore`). PyAthena builds its Athena client via boto3 and therefore relies on standard IAM-based credentials.
618+
619+
If your environment requires JWT TIP, the options are:
620+
621+
- Use the [Athena JDBC driver](https://docs.aws.amazon.com/athena/latest/ug/connect-with-jdbc.html) or [ODBC driver](https://docs.aws.amazon.com/athena/latest/ug/odbc-driver.html) directly.
622+
- Use IAM Identity Center with role-based access (assume-role flow) — see the [Assume role provider](#assume-role-provider) examples above. This is not byte-equivalent to TIP but satisfies most SSO-driven access-control requirements.
623+
624+
This is a limitation of the AWS SDK, not of PyAthena. If `boto3`/`botocore` adds JWT TIP support in the future, PyAthena will expose it via `Connection`.

0 commit comments

Comments
 (0)