VOOZH about

URL: https://www.cdata.com/kb/tech/auth0-jdbc-squirrel-sql.rst

โ‡ฑ How to connect to Auth0 Data with Squirrel SQL client


How to connect to Auth0 Data with Squirrel SQL client

๐Ÿ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to Auth0 data and execute queries in the Squirrel SQL Client.

The CData JDBC Driver for Auth0 enables you to execute queries to Auth0 data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for Auth0 data and execute queries.

Add the JDBC Driver for Auth0

Follow the steps below to add the driver JAR.

  1. In Squirrel SQL, click Windows -> View Drivers.
  2. Click the plus icon to open the Add Driver wizard.
  3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for Auth0.
  4. In the Example URL box, enter jdbc:api:
  5. In the Extra Class Path tab, click Add.
  6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
  7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.api.APIDriver.
๐Ÿ‘ The definition for the JDBC data source. (Salesforce is shown.)

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

  1. Click Windows -> View Aliases.
  2. In the pane that lists the aliases, click the plus icon.
  3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

    • Name: Enter a name for the alias; for example, CData Auth0 Source.
    • Driver: Select the CData JDBC Driver for Auth0.
    • URL: Enter jdbc:api:
    ๐Ÿ‘ The alias definition, containing the connection parameters. (Salesforce is shown.)
  4. If you want to define any additional properties, click Properties.
  5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
  6. In the Specify column, select the checkboxes for the required connection properties.

    Start by setting the Profile connection property to the location of the Auth0 Profile on disk (e.g. C:\profiles\Auth0.apip). Next, set the ProfileSettings connection property to the connection string for Auth0 (see below).

    Auth0 API Profile Settings

    Create a Machine to Machine application in your Auth0 Dashboard under Applications, then authorize it for the Auth0 Management API with the required scopes.

    Below is a typical connection string:

    jdbc:api:Profile=C:\profiles\Auth0.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
    
    ๐Ÿ‘ Connection properties automatically detected by Squirrel SQL. (Salesforce is shown.)
  7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query Auth0 Data

After the metadata has loaded, a new tab for the Auth0 data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

๐Ÿ‘ Column metadata for a table. (Salesforce is shown.)

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

๐Ÿ‘ Tables can be edited on the Content tab. (Salesforce is shown.)

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:

SELECT Id, TriggerId FROM ActionBindings WHERE DisplayName = 'my-action-binding'
๐Ÿ‘ A query and the results. (Salesforce is shown.)