This section describes how to set up ODBC connectivity and configure DSNs on several Linux distributions: Debian-based systems, like Ubuntu, and Red Hat Linux platforms, like Red Hat Enterprise Linux (RHEL) and Fedora.

Minimum Linux Versions

Here are the minimum supported versions for Red Hat-based and Debian-based systems:

OS	Min. Version
Ubuntu	18.04
Debian	10
RHEL	8
Fedora	28
SUSE	15

Installing the Driver Dependencies

Run the following commands as root or with sudo to install the necessary dependencies:

• Debian/Ubuntu:
  

  apt-get install libc6 libstdc++6 zlib1g libgcc1

• RHEL/Fedora:
  

  yum install glibc libstdc++ zlib libgcc

Installing the Driver

You can use standard package management systems to install the driver.

On Debian-based systems, like Ubuntu, run the following command with root or sudo:

dpkg -i /path/to/driver/setup/DocuSignODBCDriverforUnix.deb 

On systems that support the RPM package format, run the following command with root or sudo:

rpm -ivh /path/to/driver/DocuSignODBCDriverforUnix.rpm 

Licensing the Driver

Run the following commands to license the driver. To activate a trial, omit the <key> input.

cd /opt/cdata/cdata-odbc-driver-for-docusign/bin/
sudo ./install-license.sh <key>

Connecting through the Driver Manager

The driver manager loads the driver and passes function calls from the application to the driver. You need to register the driver with the driver manager and you define DSNs in the driver manager's configuration files.

The driver installation registers the driver with the unixODBC driver manager and creates a system DSN. The unixODBC driver manager can be used from Python and from many other applications. Your application may embed another driver manager.

Creating the DSN

See Using unixODBC to install unixODBC and configure DSNs. See Using the DataDirect Driver Manager to create a DSN to connect to OBIEE, Informatica, and SAS.

Connecting to DocuSign

UseSandbox
UseSandbox indicates whether the current user account is sandbox or not. This is false by default. Set to true if you are using a sandbox account. All the OAuth flows documented below assume that you have set UseSandbox beforehand.

AccountId
AccountId is an optional connection property. It sets automatically after the authentication succeeds. As an alternative, you can manually set it in the connection string if you have access to multiple Account Ids. In order to retrieve account ids, query the UserInfo view.

Authenticating to DocuSign

DocuSign uses the OAuth authentication standard. To authenticate using OAuth, you must create a custom app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. The driver support OAuth JWT authentication as well. See Creating a Custom OAuth App for more information about creating custom applications.

OAuth

AuthScheme must be set to OAuth in all user account flows.

Desktop Applications

Follow the steps below to authenticate with the credentials for a custom OAuth app. See Creating a Custom OAuth App.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

• OAuthClientId: Set this to the Integrator Key assigned when you registered your app.
• OAuthClientSecret: Set this to the Secret Key assigned when you registered your app.
• CallbackURL: Set this to the redirect URI defined when you registered your app.

When you connect the driver opens the OAuth endpoint in your default browser. Log in and grant permissions to the application.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

1. Choose one of these two options:
   • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
   • Option 2: Install the driver on another machine and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.

2. Then configure the driver to automatically refresh the access token from the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

1. Choose one of these options:
   • If you are using the Embedded OAuth Application click DocuSign OAuth endpoint to open the endpoint in your browser.
   • If you are using a custom OAuth application, create the Authorization URL by setting the following properties:
     • InitiateOAuth: Set to OFF.
     • OAuthClientId: Set to the client Id assigned when you registered your application.
     • OAuthClientSecret: Set to the client secret assigned when you registered your application.
     Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.

2. Log in and grant permissions to the driver. You are then redirected to the callback URL, which contains the verifier code.
3. Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.

Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens. Set the following properties:

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

• InitiateOAuth: Set this to REFRESH.
• OAuthVerifier: Set this to the verifier code.
• OAuthClientId: Set this to the client Id in your custom OAuth application settings.
• OAuthClientSecret: Set this to the client secret in the custom OAuth application settings.
• OAuthSettingsLocation: Set this to the location of the file where the driver saves the OAuth token values that persist across connections.

After the OAuth settings file is generated, you need to re-set the following properties to connect:

• InitiateOAuth: Set this to REFRESH.
• OAuthClientId: Set this to the client Id assigned when you registered your application.
• OAuthClientSecret: Set this to the client secret assigned when you registered your application.
• OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location grants read and write permissions to the driver to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to create and install a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

• InitiateOAuth: Set this to REFRESH.
• OAuthClientId: Set this to the client Id assigned when you registered your application.
• OAuthClientSecret: Set this to the client secret assigned when you registered your application.
• OAuthSettingsLocation: Set this to the location of your OAuth settings file. Make sure this location gives read and write permissions to the driver to enable the automatic refreshing of the access token.

OAuth JWT

Set the AuthScheme to OAuthJWT.

Obtaining a User ID

Retrieve your User ID by navigating, in the DocuSign UI, to Settings > Apps and Keys > My Account Information > User ID.

Obtaining an Integration Key

Follow the procedure below to obtain an integration key:

1. Log in to a DocuSign developer account.
2. Navigate to My Apps and Keys.
3. You will see a dialog box to enter your application's name. Give your application a short, but descriptive name.
4. Click ADD to add your application. Your application is automatically assigned an integration key (GUID) value that cannot be changed. Save this value.

Application Consent

In order to connect, you must give consent to the application. DocuSign offers three different software patterns for granting consent to an integration key. Grant consent to your application using one of the following methods.

Method 1: Administrative Consent

This is the best option for customer-oriented developers, because it requires nothing from your users.

Note: This pattern can't be used by ISVs.

This method of obtaining consent has the following prerequisites:

• Your account must include the Access Management with SSO feature, though it is not required that you install SSO.
  • If your developer demo account (demo.docusign.net) does not include this feature, send an email to [email protected] and request that the feature be added to your account. Remember to include your developer demo account ID.
• You must claim your email DNS domain via the DocuSign administration tool. A domain can be claimed both by the DocuSign developer demo system (for testing and development), and by your production DocuSign account.
• Your users’ email domains must match the claimed email domain.
• Your integration key’s management account must be one of the accounts in the DocuSign organization.

If you meet these requirements, grant consent as follows:

1. In DocuSign Admin, open your organization home page.
2. In the navigation pane on the left side of the page, select Connected Apps.
3. Click Authorize Application and choose an application from the drop-down menu.
4. In the Add New Application dialog, specify the permissions you want to grant to your application.
5. Click ADD.

Method 2: Individual Consent

This option has no prerequisites and can be used by customer-oriented developers and the customers of ISVs. Each user must perform the following steps.

To obtain individual consent:

1. Run the GetConsentURL stored procedure. The procedure returns a URL.
2. Open the returned URL in your browser. A permissions page will display.
3. Click Accept to grant consent.

Method 3: Administrative Consent for Third-party (ISV) Applications

You can grant administrative consent to third party (ISV) applications.

This method of obtaining consent has the following prerequisites:

• All prerequisites for standard Administrative Consent apply (see section above).
• ISVs should also support individual consent as a backup, since SSO not all customers will be able to use administative consent.
• If you are an ISV using the JWT grant flow, then the management account tied to your application’s integration key should be a DocuSign account that your company controls.

If you meet these requirements, obtain consent as follows. Each user must perform the following steps.

1. Run the GetConsentURL stored procedure. The procedure returns a URL.
2. Open the returned URL in your browser. A permissions page will display.
3. Click Accept to grant consent.

Configuring OAuth JWT Credentials

Using the information you gathered in the above sections, set the following connection properties in the driver:

• OAuthJWTCert: The location of your private key. This should end with ".key".
• OAuthJWTCertType: PEMKEY_FILE
• OAuthJWTSubject: Your user ID.
• OAuthJWTIssuer: Your integration key.

Refreshing OAuth Values

The driver can refresh the temporary OAuth access tokens obtained during the browser-based OAuth authentication exchange. By default, the driver saves the encrypted tokens in the odbc.ini file corresponding to the DSN. Access to this odbc.ini file can be restricted in the case of System DSNs.

To enable the automatic token exchange, you can give the driver write access to the system odbc.ini. Or, you can set the OAuthSettingsLocation connection property to an alternate file path, to which the driver would have read and write access.

    OAuthSettingsLocation=/tmp/oauthsettings.txt
    

Installing Dependencies for OAuth Authentication

The OAuth authentication standard requires the authenticating user to interact with DocuSign, using a web-browser. If the first OAuth interaction is to be done on the same machine the driver is installed on, for example, a desktop application, the driver needs access to the xdg-open program, which opens the default browser.

To satisfy this dependency, install the corresponding package with your package manager:

Debian/Ubuntu Package	RHEL/Fedora Package	File
xdg-utils	xdg-utils	xdg-open

Set the Driver Encoding

The ODBC drivers need to specify which encoding to use with the ODBC Driver Manager. By default, the CData ODBC Drivers for Unix are configured to use UTF-16 which is compatible with unixODBC, but other Driver Managers may require alternative encoding.

Alternatively, if you are using the ODBC driver from an application that uses the ANSI ODBC API it may be necessary to set the ANSI code page. For example, to import Japanese characters in an ANSI application, you can specify the code page in the config file '/opt/cdata/cdata-odbc-driver-for-docusign/lib/cdata.odbc.docusign.ini':

[Driver]
AnsiCodePage = 932