Purpose

Determines which authentication method the driver uses when establishing a connection. If the specified authentication method is not supported by the database server, the connection fails and the driver throws an exception.

Valid Values

userIdPassword | kerberos | entraIDPassword | entraIDServicePrincipal | AWSIAM

Behavior

If set to userIdPassword, the driver uses user ID/password authentication. The driver supports the MD5, SCRAM-SHA-256, and SCRAM-SHA-256-PLUS password hashing mechanisms. During connection, the driver detects and uses the most secure method supported by the server. You must also provide a value for the User and Password connection properties. If a user ID and password is not specified, the driver throws an exception.

If set to kerberos, the driver uses Kerberos authentication. The ServicePrincipalName property must be specified.

If set to entraIDPassword, the driver uses the Entra ID user and password for authentication. The AzureTenantID property must be specified.

If set to entraIDServicePrincipal, the driver retrieves an access token by authenticating using the client ID of the logical server and the client secret of your Entra ID application. The AzureTenantID property must be specified.

If set to AWSIAM, the driver uses AWS (Amazon Web Services) credentials for authentication. You must also configure the AccessKey, Region, and SecretKey properties.

Notes

  • The User property provides the user ID. The Password property provides the password.

Data Source Methods

public String getAuthenticationMethod()

public void setAuthenticationMethod(String)

Default

userIdPassword

Data Type

String

See also