View a markdown version of this page

Common authentication parameters - Amazon Athena

Common authentication parameters

The parameters in this section are common to the authentication types as noted.

Use Proxy for IdP

Enables communication between the driver and the IdP through the proxy. This option is available for the following authentication plugins:

Proxy behavior in driver version 2.4.0.0

In driver version 2.4.0.0, setting this parameter to 0 does not prevent supported identity provider HTTP clients from using the proxy when UseProxy is set to 1. This behavior applies to both driver-owned clients and clients that the AWS SDK creates internally. For more information about this interaction, see Use proxy.

  • AD FS

  • Azure AD

  • Browser Azure AD

  • Browser SSO OIDC

  • JWT trusted identity propagation

  • JWT

  • JWT trusted identity propagation

  • Browser trusted identity propagation

  • Okta

  • Ping

Connection string name Parameter type Default value Connection string example
UseProxyForIdP Optional 0 UseProxyForIdP=1;

Use Lake Formation

Uses the AssumeDecoratedRoleWithSAML Lake Formation API action to retrieve temporary IAM credentials instead of the AssumeRoleWithSAML AWS STS API action. This option is available for the Azure AD, Browser Azure AD, Browser SAML, Okta, Ping, and AD FS authentication plugins.

Connection string name Parameter type Default value Connection string example
LakeformationEnabled Optional 0 LakeformationEnabled=1;

SSL insecure (IdP)

Disables SSL when communicating with the IdP. This option is available for the Azure AD, Browser Azure AD, Okta, Ping, and AD FS authentication plugins.

Important

Breaking change in v2.1.0.0: The default behavior for SSL certificate validation when connecting to identity providers has changed. In versions before 2.1.0.0, SSL validation was disabled by default. Starting in v2.1.0.0, SSL validation is enabled by default for all IdP connections. The driver also enforces TLS 1.2 as the minimum TLS version. If you use a local identity provider without a valid SSL certificate (for testing purposes only), set SSL_Insecure=1 in your connection string.

Connection string name Parameter type Default value Connection string example
SSL_Insecure Optional 0 SSL_Insecure=1;