Purpose

Determines which authentication method the driver uses when establishing a connection.

Valid values

auto | client | EntraIDAccessToken | kerberos | kerberosUIDPassword | ntlm | ssl | sslUIDPassword | userIDPassword

Behavior

If set to auto, the driver uses user ID/password, Kerberos, or NTLM authentication when establishing a connection. The driver selects an authentication method based on a combination of criteria, such as whether the application provides a user ID, the driver is running on a Windows platform, and the driver can load the DLL required for NTLM authentication. See "Using the AuthenticationMethod property" for more information about using this value.

If set to client, the driver uses the user ID of the user logged onto the system on which the driver is running to authenticate the user to the database. The Oracle database server relies on the client to authenticate the user and does not provide additional authentication. The driver ignores any user ID or password specified. This value requires the remote_os_authent parameter on the database server to be set to true.

If set to EntraIDAccessToken, the driver uses an Entra ID access token to authenticate to the server. This setting requires the EntraAccessToken property to be specified. If an access token is not specified, the driver throws an exception.

If set to kerberos, the driver uses Kerberos authentication. The driver ignores any user ID or password specified.

If set to kerberosUIDPassword, the driver first uses Kerberos to authenticate the user. Next, the driver reauthenticates the user using user ID/password authentication. If a user ID and password are not specified, the driver throws an exception. If either Kerberos or user ID/password authentication fails, the connection attempt fails and the driver throws an exception.

If set to ntlm, the driver uses NTLM authentication if the DLL required for NTLM authentication can be loaded. If the driver cannot load the DLL, the driver throws an exception. The driver ignores any user ID or password specified. This value is supported for Windows clients only.

If set to ssl, the driver uses SSL certificate information to authenticate the client with the server when using Oracle Wallet. The User Name and Password options should not be specified.

If set to sslUIDPassword, the driver uses user ID/password and SSL authentication to connect with the server when using Oracle Wallet.

If set to userIdPassword, the driver uses user ID/password authentication. If a user ID and password are not specified, the driver throws an exception.

Notes

  • The values type2 and none are deprecated, but are recognized for backward compatibility. Use the ntlm and userIdPassword values, respectively, instead.
  • The User property provides the user ID. The Password property provides the password.
  • If NewPassword is specified, its value is used only if user ID/password authentication is enabled explicitly (AuthenticationMethod=userIdPassword) or implicitly (AuthenticationMethod=auto and a user ID and password is supplied); otherwise, the driver throws an exception. See "NewPassword" for more information.

Data source method

setAuthenticationMethod

Default

auto

Data type

String

See also