How to connect to Okta Data in DBVisualizer

The CData JDBC Driver for Okta implements JDBC standards to provide connectivity to Okta data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to Okta data in DBVisualizer and use the table editor to load Okta data.

Create a New Driver Definition for Okta Data

Follow the steps below to use the Driver Manager to provide connectivity to Okta data from DBVisualizer tools.

1. In DBVisualizer, click Tools -> Driver Manager.
2. Click the plus sign "" to create a new driver.
3. Select "Custom" as the template.
4. On the Driver Settings tab:
   • Set Name to a user-friendly name (e.g. "CData Okta Driver")
   • Set URL Format to jdbc:okta:
   • In Driver artifacts and jar files (jars are loaded in order from top):
     1. Click the plus sign "" -> "Add Files"
     2. Navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\)
     3. Select the JAR file (cdata.jdbc.Okta.jar) and click "Open"
5. The Driver Class should populate automatically. If not, select class (cdata.jdbc.okta.OktaDriver).

Define the Connection to the JDBC Data Source

Close the "Driver Manager" and follow the steps below to save connection properties in the JDBC URL.

1. In the "Databases" tab, click the plus sign "" and select the driver you just created.

2. In the "Connection" section, set the following options:

   • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
   • Driver Type: Select the driver you just created.

   • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:okta: followed by the connection properties in a semicolon-separated list of name-value pairs.

     To connect to Okta, set the Domain connection string property to your Okta domain.

     You will use OAuth to authenticate with Okta, so you need to create a custom OAuth application.

     Creating a Custom OAuth Application

     From your Okta account:

     1. Sign in to your Okta developer edition organization with your administrator account.
     2. In the Admin Console, go to Applications > Applications.
     3. Click Create App Integration.
     4. For the Sign-in method, select OIDC - OpenID Connect.
     5. For Application type, choose Web Application.
     6. Enter a name for your custom application.
     7. Set the Grant Type to Authorization Code. If you want the token to be automatically refreshed, also check Refresh Token.
     8. Set the callback URL:
        • For desktop applications and headless machines, use http://localhost:33333 or another port number of your choice. The URI you set here becomes the CallbackURL property.
        • For web applications, set the callback URL to a trusted redirect URL. This URL is the web location the user returns to with the token that verifies that your application has been granted access.
     9. In the Assignments section, either select Limit access to selected groups and add a group, or skip group assignment for now.
     10. Save the OAuth application.
     11. The application's Client Id and Client Secret are displayed on the application's General tab. Record these for future use. You will use the Client Id to set the OAuthClientId and the Client Secret to set the OAuthClientSecret.
     12. Check the Assignments tab to confirm that all users who must access the application are assigned to the application.
     13. On the Okta API Scopes tab, select the scopes you wish to grant to the OAuth application. These scopes determine the data that the app has permission to read, so a scope for a particular view must be granted for the driver to have permission to query that view. To confirm the scopes required for each view, see the view-specific pages in Data Model < Views in the Help documentation.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Okta JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.okta.jar

     Fill in the connection properties and copy the connection string to the clipboard.

     When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

     A typical connection string is below:

     jdbc:okta:Domain=dev-44876464.okta.com;InitiateOAuth=GETANDREFRESH
   • NOTE: Since Okta does not require a User or Password to authenticate, you may use whatever values you wish for Database Userid and Database Password.
3. On the Connection tab, click Connect.

To browse through tables exposed by the Okta JDBC Driver, right-click a table and click "Open in New Tab."

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.

More Information & Free Trial