Attribute

SecurityToken (st)

Purpose

Specifies the security token or other HTTP header value used to make a connection to the server.

This option is required when token-based authentication is enabled (AuthenticationMethod=34 [Bearer Token] | 25 [HttpHeader] | 14 [UrlParameter]). If a security token is required and you do not supply one, the driver returns an error indicating that an invalid user or password was supplied.

For OAuth 2.0 flows, this option specifies the value of custom HTTP headers named by the Authentication Header (AuthHeader) option. If a value for the Authentication Header option is specified, and you do not supply a value for this option, the driver returns an error. This functionality is often used to pass the session string for tenant ID authentication.

Important: If setting the security token using an odbc.ini or odbcinst.ini files, be aware that the value of this option, like all options in these files, is persisted in clear text.

Valid Values

String

where:

String

is the value of the security token assigned to the user or the value of the custom header to be passed for authentication.

Notes

  • When setting the security token using a data source on Windows, the Security Token option is encrypted.

Default Value

No default value