Establishing a Connection

Creating a JDBC Data Source

You can create a JDBC data source to connect from your Java application. Creating a JDBC data source based on the CData JDBC Driver for Microsoft Planner consists of three basic steps:

Add the driver JAR file to the classpath. The JAR file is located in the lib subfolder of the installation directory. Note that the .lic file must be located in the same folder as the JAR file.

Provide the driver class. For example:

cdata.jdbc.microsoftplanner.MicrosoftPlannerDriver

Provide the JDBC URL. For example:
```
jdbc:microsoftplanner:InitiateOAuth=GETANDREFRESH;OAuthClientId=MyApplicationId;OAuthClientSecret=MySecretKey;CallbackURL=http://localhost:33333;

or

jdbc:cdata:microsoftplanner:InitiateOAuth=GETANDREFRESH;OAuthClientId=MyApplicationId;OAuthClientSecret=MySecretKey;CallbackURL=http://localhost:33333;
```
The second format above can be used whenever there is a conflict in your application between drivers using the same URL format to ensure you are using the CData driver. The URL must start with either "jdbc:microsoftplanner:" or "jdbc:cdata:microsoftplanner:" and can include any of the connection properties in name-value pairs separated with semicolons.

Connecting to Microsoft Planner

Azure AD

Azure AD is Microsoft’s multi-tenant, cloud-based directory and identity management service. It is user-based authentication that requires that you set AuthScheme to AzureAD.

Authentication to Azure AD over a Web application always requires the creation of a custom OAuth application. For details, see Creating an Azure AD Application.

Desktop Applications

CData provides an embedded OAuth application that simplifies connection to Azure AD from a Desktop application.

You can also authenticate from a desktop application using a custom OAuth application. (For further information, see Creating an Azure AD Application.) To authenticate via Azure AD, set these parameters:

AuthScheme: AzureAD.
Custom applications only:
- OAuthClientId: The client Id assigned when you registered your custom OAuth application.
- OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.
- CallbackURL: The redirect URI you defined when you registered your custom OAuth application.

When you connect, the driver opens Microsoft Planner's OAuth endpoint in your default browser. Log in and grant permissions to the application.

The driver completes the OAuth process, obtaining an access token from Microsoft Planner and using it to request data. The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.

When the access token expires, the driver refreshes it automatically.

Web Applications

To authenticate via Azure AD using a Web application, you must register a custom OAuth application with Microsoft Planner (see Creating an Azure AD Application). You can then use the driver to get and manage the OAuth token values.

Get an Azure AD OAuth Access Token

First, set these connection properties to obtain the OAuthAccessToken:

AuthScheme: AzureAD.
OAuthClientId: The client Id in your application settings.
OAuthClientSecret: The client secret in your application settings.

Next, call stored procedures to complete the OAuth exchange:

Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and set the CallbackURL input to the Redirect URI you specified in your application settings. If necessary, set the Permissions parameter to request custom permissions.
The stored procedure returns the URL to the OAuth endpoint.
Open the URL, log in, and authorize the application. You are redirected back to the callback URL.
Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the "code" parameter in the query string of the callback URL. If necessary, set the Permissions parameter to request custom permissions.

Once you have obtained the access and refresh tokens, you can connect to data and refresh the Azure AD access token either automatically or manually.

Automatic Refresh of the Azure AD OAuth Access Token

To have the driver automatically refresh the Azure AD OAuth access token, set the following parameters the first time you connect to data:

AuthScheme: AzureAD.
InitiateOAuth: REFRESH.
OAuthClientId: The client Id in your application settings.
OAuthClientSecret: The client secret in your application settings.
OAuthAccessToken: The access token returned by GetOAuthAccessToken.
OAuthRefreshToken: The refresh token returned by GetOAuthAccessToken.
OAuthSettingsLocation: The location where the driver saves the OAuth token values, which persist across connections.

On subsequent data connections, the values for OAuthAccessToken and OAuthRefreshToken are taken from OAuthSettingsLocation, and do not need to be set on the connection.

Manual Refresh of the Azure AD OAuth Access Token

The only value required to manually refresh the Azure AD OAuth access token when connecting to data is the OAuth refresh token.

Use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed, then set these connection properties:

OAuthClientId: The client Id in your application settings.
OAuthClientSecret: The client secret in your application settings.

Now call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken. After the new tokens have been retrieved, open a new connection by setting OAuthAccessToken to the value returned by RefreshOAuthAccessToken.

Finally, store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

To configure the driver with a user account on a headless machine, you must authenticate on another device that has an internet browser.

You can do this in either of the following ways:

Obtain the OAuthVerifier value as described below in Option 1: Obtain and Exchange a Verifier Code.
Install the driver on another machine as described below in Option 2: Transfer OAuth Settings. After you authenticate via the usual browser-based flow, transfer the OAuth authentication values.

Option 1: Obtain and Exchange a Verifier Code

Find the authorization endpoint.

Custom applications only: Set these properties to create the Authorization URL:
- InitiateOAuth: OFF.
- OAuthClientId: The client Id assigned when you registered your application.
- OAuthClientSecret: The client secret assigned when you registered your application.
Custom and embedded applications: Call the GetOAuthAuthorizationURL stored procedure.
1. Open the URL returned by the stored procedure in a browser.
2. Log in and grant permissions to the driver. You are redirected to the callback URL, which contains the verifier code.
3. Save the value of the verifier code. You will use this later to set the OAuthVerifier connection property.
Exchange the OAuth verifier code for OAuth refresh and access tokens.

At the headless machine, set these properties:
- AuthScheme: AzureAD.
- InitiateOAuth: REFRESH.
- OAuthVerifier: The verifier code.
- OAuthSettingsLocation: The location of the file that holds the OAuth token values that persist across connections.
- Custom applications only:
  - OAuthClientId: The client Id in your custom OAuth application settings.
  - OAuthClientSecret: The client secret in the custom OAuth application settings.
After the OAuth settings file is generated, reset the following properties to connect:
- InitiateOAuth: REFRESH.
- OAuthSettingsLocation: The location containing the encrypted OAuth authentication values. Make sure this location grants read and write permissions to the driver to enable the automatic refreshing of the access token.
- Custom applications only:
  - OAuthClientId: The client Id assigned when you registered your application.
  - OAuthClientSecret: The client secret assigned when you registered your application.

Option 2: Transfer OAuth Settings

Before you can connect via a headless machine, you must create and install a connection with the driver on a device that supports an internet browser. Set the connection properties as described above, in Desktop Applications.

After you complete the instructions in Desktop Applications, the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.

At the headless machine, set these properties:

AuthScheme: AzureAD.
InitiateOAuth: REFRESH.
OAuthSettingsLocation: The location of your OAuth settings file. Make sure this location gives read and write permissions to the driver to enable the automatic refreshing of the access token.
Custom applications only:
- OAuthClientId: The client Id assigned when you registered your application.
- OAuthClientSecret: The client secret assigned when you registered your application.

Azure Service Principal

The authentication as an Azure Service Principal is handled via the OAuth Client Credentials flow. It does not involve direct user authentication. Instead, credentials are created for just the application itself. All tasks taken by the app are done without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

Create an AzureAD App and an Azure Service Principal

When authenticating using an Azure Service Principal, you must create and register an Azure AD application with an Azure AD tenant. See Creating an Azure AD Application for more details.

In your App Registration in portal.azure.com, navigate to API Permissions and select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated permissions and Application permissions. The permissions used during client credential authentication are under Application Permissions.

Assign a role to the application

To access resources in your subscription, you must assign a role to the application.

Open the Subscriptions page by searching and selecting the Subscriptions service from the search bar.
Select the subscription to assign the application to.
Open the Access control (IAM) and select Add > Add role assignment to open the Add role assignment page.
Select Owner as the role to assign to your created Azure AD app.

Complete the Authentication Choose whether to use a client secret or a certificate and follow the relevant steps below.

Client Secret

Set these connection properties:

AuthScheme: AzureServicePrincipal to use a client secret.
InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
AzureTenant: The tenant you want to connect to.
OAuthClientId: The client Id in your application settings.
OAuthClientSecret: The client secret in your application settings.

Certificate

Set these connection properties:

AuthScheme: AzureServicePrincipalCert to use a certificate.
InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
AzureTenant: The tenant you want to connect to.
OAuthJWTCert: The JWT Certificate store.
OAuthJWTCertType: The type of the certificate store specified by OAuthJWTCert.

You are now ready to connect. Authentication with client credentials takes place automatically like any other connection, except there is no window opened prompting the user. Because there is no user context, there is no need for a browser popup. Connections take place and are handled internally.

Managed Service Identity (MSI)

If you are running Microsoft Planner on an Azure VM and want to leverage MSI to connect, set AuthScheme to AzureMSI.

User-Managed Identities

To obtain a token for a managed identity, use the OAuthClientId property to specify the managed identity's "client_id".

When your VM has multiple user-assigned managed identities, you must also specify OAuthClientId.