VOOZH about

URL: https://www.cdata.com/kb/tech/okta-jdbc-dbvr.rst

⇱ How to Connect DBeaver to Okta via a JDBC Driver


How to Connect DBeaver to Okta via a JDBC Driver

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Manage Okta data with visual tools in DBeaver like the query browser.

The CData JDBC Driver for Okta implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Okta data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Okta Data

Follow the steps below to load the driver JAR in DBeaver.

  1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
  2. In the Settings tab:
    • Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for Okta).
    • Set Class Name to the class name for the JDBC driver: cdata.jdbc.okta.OktaDriver.
    • Set URL Template to jdbc:okta:.
    πŸ‘ Configure the new driver settings (Salesforce is shown).
  3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.Okta.jar). πŸ‘ Loading the JDBC JAR file (Salesforce is shown).

Create a Connection to Okta Data

Follow the steps below to add credentials and other required connection properties.

  1. In the "Database" menu, click "New Database Connection."
  2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for Okta) and click "Next >." πŸ‘ Selecting the driver (Salesforce is shown).
  3. On the Main tab of the configuration wizard, set the JDBC URL, using the required connection properties:

    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 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.

    πŸ‘ Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

    Below is a typical connection string:

    jdbc:okta:Domain=dev-44876464.okta.com;InitiateOAuth=GETANDREFRESH;
    
    πŸ‘ Configuring the JDBC URL (Salesforce is shown).
  4. Click "Test Connection ..." to ensure you have configured the connection properly. πŸ‘ A successfully configured connection (Salesforce is shown).
  5. Click "Finish."

Query Okta Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

πŸ‘ The results of a query in DBeaver. (Salesforce is shown.)

More Information & Free Trial

Download a free, 30-day trial of the CData JDBC Driver for Okta and start working with your live Okta data in DBeaver. Join the CData Community or reach out to our Support Team if you have any questions.