You need the following information before you begin.

  • Server Name - the endpoint of the GitHub service to which you are connecting
  • Auth URI - the endpoint for obtaining an authorization code from a third-party authorization service
  • Token URI - the endpoint used to exchange authentication credentials for access tokens
  • Client ID - the client ID for your application
  • Client Secret - the client secret for your application
  • Scope - an OAuth scope, or a space-separated list of OAuth scopes, which specifies the permissions that limit application access to the GitHub service.

The following steps describe how you can use the Progress DataDirect GitHub Configuration Manager to obtain access token for the access token flow grant. In addition, the Configuration Manager produces a connection URL that you can use in your application.

Note: You must allow popups in your browser to obtain access tokens with the Configuration Manager.
  1. Open the GitHub Configuration Manager by double-clicking the driver jar file. Or, in a command line, navigate to the directory containing your driver jar file; then, execute the following command: 
    java -jar GitHub.jar

    The GitHub Configuration Manager opens in your default web browser.

  2. Set Authentication Method to OAuth2.
  3. Provide the following information in the fields provided.
    • Server Name
    • Authorization URI
    • Token URI
    • Client ID
    • Client Secret
    • Scope
  4. Obtain access tokens.
    1. Click Fetch OAuth Token.
    2. If logon popup appears, enter your GitHub credentials. (This popup may not appear if you previously logged on.)
    3. If consent popup appears, provide consent, allowing the Configuration Manager to retrieve the tokens. (This popup may not appear if you previously provided consent to the Configuration Manager.)
    4. The Access Token field populates with values retrieved from the OAuth authorization server.
  5. Click Test Connect to verify connectivity and run SQL queries against the service.

Results:

The Access Token field includes access tokens that you can use to implement OAuth 2.0.

The connection string in the Connection String field may be copied and used in your JDBC application to connect with your GitHub service.

Note:

Not all the values in the resulting connection string are required. However, the connection string can be copied directly into your JDBC application. The driver ignores any values that do not apply to your OAuth implementation.

For example, the access token grant connection string, derived from the Configuration Manager, might include the following properties.

jdbc:datadirect:github:ServerName=server_name;
AuthURI=auth_uri;TokenURI=token_uri;
ClientID=client_id;ClientSecret=client_secret;
AccessToken=access_token;Scope=scope;

However, only the following properties are required for an access token grant connection string.

jdbc:datadirect:github:ServerName=server_name;
TokenURI=token_uri;ClientID=client_id;
ClientSecret=client_secret;AccessToken=access_token;