FireDAC Components for Azure Data Management

Build 20.0.7587

Headless Machines

Using OAuth on a Headless Machine

To create Azure Data Management data sources on headless servers or other machines on which the component cannot open a browser, you need to authenticate from another machine. Authentication is a two-step process.

  1. Instead of installing the component on another machine, you can follow the steps below to obtain the OAuthVerifier value. Or, you can install the component on another machine and transfer the OAuth authentication values, after you authenticate through the usual browser-based flow.
  2. You can then configure the component to automatically refresh the access token from the headless machine.
You can follow the headless OAuth authentication flow using the component's embedded OAuth credentials or using the OAuth credentials for your custom OAuth app.

Using the Embedded OAuth Credentials

Obtain a Verifier Code

Follow the steps below to authenticate from another machine and obtain the OAuthVerifier connection property:

  1. Click the following link to open the Azure Data Management OAuth endpoint in your browser.
  2. Log in and grant permissions to the component. You are then redirected to the callback URL, which contains the verifier code.
  3. Save the value of the verifier code. You will set this in the OAuthVerifier connection property.

On the headless machine, set the following connection properties to obtain the OAuth authentication values.

  • OAuthVerifier: Set this to the verifier code.
  • InitiateOAuth: Set this to REFRESH.
  • OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified file.
  • Tenant (optional): Set this to authenticate to a different tenant than your default. This is required to work with a subscription not on your default tenant.

After the OAuth settings file is generated, set the following properties to connect to data:

  • OAuthSettingsLocation: Set this to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.
  • InitiateOAuth: Set this to REFRESH.
  • SubscriptionId (optional): A subscription Id is required for Azure API Management endpoints, so if you do not specify one, the component gets the first subscription Id available in your account.
  • Tenant (optional): Set this to authenticate to a different tenant than your default. This is required to work with a subscription not on your default tenant.

Transfer OAuth Settings

Follow the steps below to install the component on another machine, authenticate, and then transfer the resulting OAuth values.

On a second machine, install the component and connect with the following properties set:

  • OAuthSettingsLocation: Set this to a writable text file.
  • Set InitiateOAuth to GETANDREFRESH.
  • Tenant (optional): Your tenant can be specified if you wish to authenticate to a different tenant than your default. This is required to work with a Subscription not on your default Tenant.

Test the connection to authenticate in the browser. The resulting authentication values are written, encrypted, to the path specified by OAuthSettingsLocation. Once you have successfully tested the connection, copy the OAuth settings file to your headless machine. On the headless machine, set the following connection properties to connect to data:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthSettingsLocation: Set this to the path to your OAuth settings file. Make sure this file gives read and write permissions to the component to enable the automatic refreshing of the access token.
  • SubscriptionId (optional): A subscription Id is required for Azure API Management endpoints, so if you do not specify one, the component gets the first subscription Id available in your account.
  • Tenant (optional): Set this to authenticate to a different tenant than your default. This is required to work with a subscription not on your default tenant.

Using the Credentials for a Custom OAuth App

Create a Custom OAuth App

Creating a custom OAuth app is optional in the headless OAuth flow; you can skip creating an app by connecting with the component's embedded OAuth credentials. You might want to create a custom OAuth app to change the information displayed when users log into Azure Data Management to grant permissions to the component.

See Creating a Custom OAuth App for a procedure. You can then follow the procedures below to authenticate and connect to data.

Obtain a Verifier Code

Set the following properties on the headless machine:

  • InitiateOAuth: Set this to OFF.
  • OAuthClientId: Set this to the Client Id in your app settings.
  • OAuthClientSecret: Set this to the Client Secret in your app settings.
  • Tenant (optional): Set this to authenticate to a different tenant than your default. This is required to work with a subscription not on your default tenant.

You can then follow the steps below to authenticate from another machine and obtain the OAuthVerifier connection property.

  1. Call the GetOAuthAuthorizationUrl stored procedure with the CallbackURL input parameter set to the exact Redirect URI you specified in your app settings.
  2. Open the returned URL in a browser. Log in and grant permissions to the component. You are then redirected to the callback URL, which contains the verifier code.
  3. Save the value of the verifier code. You will set this in the OAuthVerifier connection property.

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

  • OAuthVerifier: Set this to the verifier code.
  • OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified file.
  • InitiateOAuth: Set this to REFRESH.
  • Tenant (optional): Set this to authenticate to a different tenant than your default. This is required to work with a subscription not on your default tenant.

Connect to Data

After the OAuth settings file is generated, set the following properties to connect to data:

  • OAuthSettingsLocation: Set this to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.
  • InitiateOAuth: Set this to REFRESH.
  • SubscriptionId (optional): A subscription Id is required for Azure API Management endpoints, so if you do not specify one, the component gets the first subscription Id available in your account.
  • Tenant (optional): Set this to authenticate to a different tenant than your default. This is required to work with a subscription not on your default tenant.

Transfer OAuth Settings

Follow the steps below to install the component on another machine, authenticate, and then transfer the resulting OAuth values.

On a second machine, install the component and connect with the following properties set:

  • OAuthSettingsLocation: Set this to a writable text file.
  • Set InitiateOAuth to GETANDREFRESH.
  • OAuthClientId: Set this to the client Id assigned when you registered your app.
  • OAuthClientSecret: Set this to the client secret assigned when you registered your app.
  • CallbackURL: Set this to the Sign-On URL you specified in your app settings.
  • Tenant (optional): Your tenant can be specified if you wish to authenticate to a different tenant than your default. This is required to work with a Subscription not on your default Tenant.

Test the connection to authenticate. The resulting authentication values are written, encrypted, to the path specified by OAuthSettingsLocation. Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthSettingsLocation: Set this to the path to your OAuth settings file. Make sure this file gives read and write permissions to the component to enable the automatic refreshing of the access token.
  • SubscriptionId (optional): A subscription Id is required for Azure API Management endpoints, so if you do not specify one, the component gets the first subscription Id available in your account.
  • Tenant (optional): Set this to authenticate to a different tenant than your default. This is required to work with a subscription not on your default tenant.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587