SSIS Components for Avro

Build 21.0.7930

Connecting to Box

Use the OAuth authentication standard to connect to Avro. You can connect with your user account or you can use a service account. The component facilitates these OAuth flows as described below.

Authenticate with a User Account

The user account flow requires the authenticating user to interact with Avro via the browser.

You can connect without setting any connection properties for your user credentials. After setting InitiateOAuth to GETANDREFRESH, you are ready to connect. 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. Obtains a new access token when the old one expires.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Note: The component is already registered with Avro as an OAuth application and will automatically use its embedded OAuth credentials to connect.

Authenticate with a Service Account

Service accounts have silent authentication, without user authentication in the browser. You need to create an OAuth application in this flow. You can then connect to Avro data that the service account has permission to access.

After setting the following connection properties, you are ready to connect:

  • InitiateOAuth: Set this to GETANDREFRESH.
  • OAuthClientId: Set this to the Client Id in your app settings.
  • OAuthClientSecret: Set this to the Client Secret in your app settings.
  • OAuthJWTCertType: Set this to "PEMKEY_FILE".
  • OAuthJWTCert: Set this to the path to the .pem file you generated.
  • OAuthJWTCertPassword: Set this to the password of the .pem file.
  • OAuthJWTCertSubject: Set this to "*" to pick the first certificate in the certificate store.
  • OAuthJWTSubjectType: Set this to "enterprise" or "user" depending on the type of token you want to request. You also need to set the Application Access value in your app settings to the corresponding subject type. The default value of this connection property is "enterprise".
  • OAuthJWTSubject: Set this to your enterprise Id if your subject type is set to "enterprise" or your app user Id if your subject type is set to "user".
  • OAuthJWTPublicKeyId: Set this to the Id of your public key in your app settings.
When you connect the component completes the OAuth flow for a service account.
  1. Creates and signs the JWT with the claim set required by the component.
  2. Exchanges the JWT for the access token.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
  4. Submits the JWT for a new access token when the token expires.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930