skip to main content
Connection property descriptions : CustomAuthParams
  

Try DataDirect Drivers Now

CustomAuthParams

Purpose

Specifies a list of parameter values used by custom authentication requests that are defined in the input REST file. This property allows you to configure parameter values used in custom authentication requests on a per connection basis, without editing the REST file, and securely pass them in a connection string or data source definition.
The input REST file references the values of this property using the CustomAuthParams variable followed by an index location surrounded in square brackets. For example, a value of CustomAuthParams[3] refers to the third value specified by this property.
See "Custom authentication requests" for a detailed description of defining custom authentication requests in the input REST file.

Valid Values

authentication_parameter [[; authentication_parameter ]...]
where:
authentication_parameter
is an authentication parameter value used in a custom authentication requests defined in the input REST file. This value can be any parameter value used in the request that is not already mapped to an existing connection property, for example api-key tokens, company names, and website names.
Important: The index value specified for the variable in the REST file corresponds to the order in which these values are specified for the property.

Example

If you needed to reference the value My Company Inc for the following company field in the definition for a custom authentication request:
"company": "{CustomAuthParams[2]}"
Since the variable is pointing to the 2 index location, you would specify My Company Inc as the second value in the connection property:
CustomAuthParams=123XYZ456abc789;My Company Inc;www.example.com

Notes

*This property is enabled when AuthenticationMethod=Custom; otherwise, it is ignored.

Data Source Method

setCustomAuthParams

Default

None

Data Type

String