Attribute

AuthenticationMethod (am)

Purpose

Determines which authentication method the driver uses during the course of a session.

Valid Values

15 | 43 | 0 | 34 | 24 | 50 | 51 | 56 | 52 | 53 | 54 | 55 | 25 | 14 | 30 | 29

Behavior

If set to 15 (None), the driver does not attempt to authenticate.

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

If set to 0 (Basic), the driver uses a hashed value, based on the concatenation of the user name and password, for authentication. In addition to the User and Password options, you must also configure the AuthHeader option if the name of your HTTP header is not Authorization (the default).

If set to 34 (BearerToken), the driver uses an API Token, configured as BearerToken, for authentication. The BearerToken is specified via the SecurityToken option.

If set to 24 (OAuth2), the driver uses OAuth 2.0 to authenticate to REST endpoints. This is a legacy value that allows you to connect to all supported grant flows. When this value is set, the driver determines which grant type to use based on the OAuth 2.0 related options you specify. This setting differs from other OAuth 2.0 values in that, when specified, it exposes all OAuth 2.0 related options on the Configuration Manager, instead of only those related to a specified grant type. See "OAuth 2.0 authentication" for details.

If set to 50 (OAuth2-AccessToken), the driver uses the access token authentication flow to authenticate to REST endpoints. See "OAuth 2.0 authentication" for details.

If set to 51 (OAuth2-AuthorizationCode), the driver uses authorization code grant to authenticate to REST endpoints. When EnableLoginPrompt=1 and SQLEngineMode=2, the driver uses dynamic authorization flow.

If set to 56 (OAuth2-PKCE), the driver uses the PKCE grant to authenticate to REST endpoints. Note that this option is supported only when the SQL Engine is running in direct mode (SQLEngineMode=2) See "OAuth 2.0 authentication" for details.

If set to 52 (OAuth2-Password),the driver uses the password grant authentication to authenticate to REST endpoints. See "OAuth 2.0 authentication" for details.

If set to 53 (OAuth2-ClientCredentials), the driver uses the client credentials grant to authenticate to REST endpoints. See "OAuth 2.0 authentication" for details.

If set to 54 (OAuth2-RefreshToken), the driver uses the refresh token grant to authenticate to REST endpoints. See "OAuth 2.0 authentication" for details.

If set to 55 (OAuth2-JWTBearer), the driver uses the JWT bearer token grant to authenticate to REST endpoints. See "OAuth 2.0 authentication" for details.

If set to 25 (HTTPHeader), the driver passes security tokens via HTTP headers for authentication. You must also configure SecurityToken option and, if the name of your HTTP header is not Authorization (the default), the AuthHeader option.

If set to 14 (URLParameter), the driver passes security tokens via the URL for authentication. You must also configure the AuthParam and SecurityToken options.

If set to 30 (Digest), the driver uses digest access authentication to negotiate username and password authentication. You must also configure the User and Password options.

If set to 29 (Custom), the driver uses custom authentication requests specified in the REST config file to login to server and generate the credentials needed to authenticate data requests.

Default Value

15 (None)