Purpose

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

This property is required when token-based authentication is enabled (AuthenticationMethod=BearerToken | HttpHeader | 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 property specifies the value of custom HTTP headers named by the AuthHeader property. If a value for the AuthHeader property is specified, and you do not supply a value for this property, 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 a DataSource class, be aware that the SecurityToken property, like all DataSource properties, 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.

Data Source Methods

public String getSecurityToken()

public void setSecurityToken(String)

Default Value

No default value

Data Type

String