Parameter Wallet String

AuthenticationParameter / MechanismKey

Key Name Default Value Required

AuthenticationParameter

OR

MechanismKey

None

Yes, if authenticating using a JSON web token (JWT).

Description

Additional parameters that might be required for authentication. For example, if you are authenticating your connection to the database using a JSON web token (JWT), then you must specify a token parameter.

Depending on whether you are connecting using a DSN or a connection string, you need to use different methods to specify your parameters:

  • When setting this option in a DSN, you must specify a Teradata Wallet reference string that is mapped to your parameters. You cannot specify the parameters directly in the DSN.
  • When setting this option in a connection string, you may choose to specify your parameters directly in the connection string.

Additionally, when specifying a reference string in a connection string, you must enclose the reference string inside the $tdwallet() syntax. If you are specifying the reference string in the Simba Teradata ODBC Connector DSN Setup dialog box instead, you can choose to specify the reference string value without that syntax.

Additionally, when specifying a reference string, you must enclose the string inside the $tdwallet() syntax.

Note:

  • The Teradata Wallet utility must be installed and configured before you can connect to the database using a reference string. For more information, see Teradata Wallet.
  • When specifying a parameter directly in a connection string, if the parameter contains any of the following special characters, you must enclose the parameter in braces ({}):

    • * @ [] {} , = ! () ? ;

For example, depending on whether you are connecting using a connection string or a DSN, you would provide a JWT using one of the following ways:

  • When configuring a DSN through the Simba Teradata ODBC Connector DSN Setup dialog box, in the Parameter Wallet String field, type the reference string. You can choose whether or not to include the $tdwallet() syntax.
  • When configuring a DSN using the odbc.ini file, set the following connection property, where [ReferenceString] is the reference string:

    • AuthenticationParameter=$tdwallet([ReferenceString])

  • When writing a connection string, you can set the AuthenticationParameter property to the reference string, using the following syntax where [ReferenceString] is the reference string:

    • AuthenticationParameter=$tdwallet([ReferenceString])

    Or, you can set the AuthenticationParameter property to the token parameter, using the following syntax where [JWT_Token] is the JWT value:

    AuthenticationParameter={token=[JWT_Token]}

Related topics