Create a Data Access Object for Auth0 Data using JDBI

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for Auth0 integrates connectivity to live Auth0 data in Java applications. By pairing these technologies, you gain simple, programmatic access to Auth0 data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read Auth0 data.

Create a DAO for the Auth0 ActionBindings Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyActionBindingsDAO {
  //request specific data from Auth0 (String type is used for simplicity)
  @SqlQuery("SELECT TriggerId FROM ActionBindings WHERE DisplayName = :displayName")
  String findTriggerIdByDisplayName(@Bind("displayName") String displayName);

  /*
   * close with no args is used to close the connection
   */
  void close();
}

Open a Connection to Auth0

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Auth0.

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.

Built-in Connection String Designer

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

java -jar cdata.jdbc.api.jar

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

A connection string for Auth0 will typically look like the following:

jdbc:api:Profile=C:\profiles\Auth0.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Auth0.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;");
MyActionBindingsDAO dao = dbi.open(MyActionBindingsDAO.class);

//do stuff with the DAO

dao.close();

Read Auth0 Data

With the connection open to Auth0, simply call the previously defined method to retrieve data from the ActionBindings entity in Auth0.

//disply the result of our 'find' method
String triggerId = dao.findTriggerIdByDisplayName("my-action-binding");
System.out.println(triggerId);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Auth0 by integrating with the CData JDBC Driver for Auth0. Download a free trial and work with live Auth0 data in custom Java applications today.