You need the following information before you begin.

  • Service URL - the URL of the SharePoint site (or "site collection") to which you are connecting
  • Authorization URI - the endpoint for obtaining an authorization code from the Azure 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 (only for Microsoft Identity Platform v2)

The following steps describe how you can use the Progress DataDirect SharePoint Configuration Manager to obtain access and refresh tokens for either the access token flow or the refresh token 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 and refresh tokens with the Configuration Manager.
  1. Open the SharePoint 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 sharepoint.jar

    The SharePoint Configuration Manager opens in your default web browser.

  2. Set Authentication Method to OAuth2.
  3. Provide the following information in the fields provided.
    • Service URL
    • Authorization URI
    • Token URI
    • Client ID
    • Client Secret
    • Scope (only for Microsoft Identity Platform v2)
      Note: If you are using the Microsoft Identity Platform (v2) to provision users and manage application access, the scope must include the offline_access permission to retrieve a refresh token. This permission allows the Configuration Manager to retrieve a refresh token, and, by way of the refresh token grant, provides the application with prolonged access to the SharePoint site. See also Determine the Scope.
  4. Retrieve access and refresh tokens.
    1. Click Fetch OAuth Token.
    2. If logon popup appears, enter Azure Active Directory 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 and Refresh Token fields populate 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 and Refresh Token fields include access and refresh 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 SharePoint 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 refresh token grant connection string, derived from the Configuration Manager, might include the following properties.

jdbc:datadirect:sharepoint:ServiceURL=serviceurl;
AuthURI=auth_uri;TokenURI=token_uri;
ClientID=client_id;ClientSecret=client_secret;
AccessToken=access_token;RefreshToken=refresh_token;
Scope=scope;

However, only the following properties are required for a refresh token grant connection string.

jdbc:datadirect:sharepoint:ServiceURL=serviceurl;
TokenURI=token_uri;ClientID=client_id;
ClientSecret=client_secret;RefreshToken=refresh_token;