SSIS Components for Azure Data Management

Build 20.0.7587

Custom Credentials

When to Use a Custom OAuth App

Creating a custom OAuth app is optional as the component is already registered with Azure Data Management and you can connect with its embedded 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.

Desktop Authentication with a Custom OAuth App

Follow the steps below to authenticate with the credentials for a custom OAuth app.

See Creating a Custom OAuth App.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

  • 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.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • 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): 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.
When you connect the component opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The component then completes the OAuth process:
  1. Extracts the access token from the callback URL and authenticates requests.
  2. Refreshes the access token when it expires.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

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