skip to main content
Using the driver : Using connection properties : URL parameter authentication properties
  

Try DataDirect Drivers Now

URL parameter authentication properties

The following table summarizes connection properties which are required for URL parameter authentication.
Table 12. Authentication Properties
Property
Characteristic
Determines which authentication method the driver uses during the course of a session.
If set to None, the driver does not attempt to authenticate.
If set to 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 properties, you must also configure the AuthHeader property if the name of your HTTP header is not Authorization (the default).
If set to Custom, the driver uses the custom token-based authentication flow that is defined in the input REST file.
If set to HttpHeader, the driver passes security tokens via HTTP headers for authentication. You must also configure SecurityToken property and, if the name of your HTTP header is not Authorization (the default), the AuthHeader property.
If set to OAuth2, the driver uses OAuth 2.0 to authenticate to REST endpoints.
If set to UrlParameter, the driver passes security tokens via the URL for authentication. You must also configure the AuthParam and SecurityToken properties.
The default is None.
Specifies the name of the URL parameter used to pass the security token. This property is required when using URL parameters to pass tokens for authentication (AuthenticationMethod=UrlParameter); otherwise, this property is ignored.
Specifies the security token required to make a connection to your REST API endpoint. This property is required when token based authentication is enabled (AuthenticationMethod=HttpHeader | UrlParameter); otherwise, this property is ignored. 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.
Specifies the user name that is used to connect to the REST service. A user name is required if user is enabled by your REST service. This property is ignored when AuthenticationMethod=None.