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/OktaODBCDriverforUnix.deb 

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

rpm -ivh /path/to/driver/OktaODBCDriverforUnix.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-okta/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 Okta

To connect to Okta, set this parameter:

• Domain: Your Okta domain.

Authenticating to Okta

Okta supports OAuth authentication only. To enable this authentication from all OAuth flows, you must create a custom OAuth application.

The following subsections describe how to authenticate to Okta from three common authentication flows.

For information about how to create a custom OAuth application, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in Okta, see Connection.

Desktop Applications

To connect via a desktop application, you must set and refresh the OAuth acess token.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

• OAuthClientId: The Key displayed when you created your custom OAuth application.
• OAuthClientSecret: The Secret displayed when you created your custom OAuth application.
• CallbackURL: The Callback URL defined when you registered your application. This is typically set to http://localhost:33333.

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

When the access token expires, the driver refreshes it automatically.

Automatic Refresh of the OAuth Access Token

To have the driver automatically refresh the OAuth access token:

1. Before connecting to data for the first time, set these connection parameters:
   • InitiateOAuth: REFRESH.
   • OAuthClientId: The Key displayed when you created your custom OAuth application.
   • OAuthClientSecret: The Secret displayed when you created your custom OAuth application.
   • OAuthAccessToken: The access token returned by GetOAuthAccessToken.
   • OAuthSettingsLocation: The path where you want the driver to save the OAuth values, which persist across connections.

2. On subsequent data connections, set:
   • InitiateOAuth
   • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
2. Set these connection properties:
   • OAuthClientId: The Client Id in your custom OAuth application settings.
   • OAuthClientSecret: The Client Secret in your custom OAuth application settings.

3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

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.

Note: Depending on whether AuthScheme is set to code or client, authentication is performed with either an authorization code or a client credentials grant type.

You can do this in either of the following ways:

• Option 1: Obtain the OAuthVerifier value.
• Option 2: Install the driver on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow.

After you execute either Option 1 or Option 2, configure the driver to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL as follows:

1. Authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

   Set these properties:

   • InitiateOAuth: OFF.
   • OAuthClientId: The Key displayed when you created your custom OAuth application.
   • OAuthClientSecret: The Secret displayed when you created your custom OAuth application.

2. Call the GetOAuthAuthorizationURL stored procedure. The stored procedure returns the CallbackURL established when the custom OAuth application was registered. (See Creating a Custom OAuth Application.)

   Copy this URL and paste it into a new browser tab.

3. Log in and grant permissions to the driver. The OAuth application redirects you the redirect URI, with a parameter called code appended. Note the value of this parameter; you will need it later, to configure the OAuthVerifier connection property.

4. Exchange the OAuth verifier code for OAuth refresh and access tokens.

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

   • InitiateOAuth: REFRESH.
   • OAuthVerifier: The verifier code (the value of the code parameter in the Callback URL).
   • OAuthClientId: The Key displayed when you created your custom OAuth application.
   • OAuthClientSecret: The Secret displayed when you created your custom OAuth application.
   • OAuthSettingsLocation: Persist the encrypted OAuth authentication values to the specified location.

5. Test the connection to generate the OAuth settings file.

6. You are ready to connect after you re-set these properties:

   • InitiateOAuth: REFRESH.
   • OAuthClientId: The Key displayed when you created your custom OAuth application.
   • OAuthClientSecret: The Secret displayed when you created your custom OAuth application.
   • OAuthSettingsLocation: The location containing the encrypted OAuth authentication values. To enable the automatic refreshing of the access token, be sure that this file gives read and write permissions to the driver.

Option 2: Transfer OAuth Settings

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

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

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

To connect to data via the headless machine, set these connection properties:

• InitiateOAuth: REFRESH.
• OAuthClientId: The Secret displayed when you created your custom OAuth application.
• OAuthSettingsLocation: The location of the OAuth settings file you copied from the machine with the browser. To enable automatic refreshing of the access token, ensure that this file gives read and write permissions to the driver.

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-okta/lib/cdata.odbc.okta.ini':

[Driver]
AnsiCodePage = 932