uses the OAuth authentication standard, which requires the authenticating user to interact with via the browser. The adapter facilitates the OAuth exchange in various ways, as described in this section.

Create a Connected App

To obtain the OAuth client credentials, including the OAuthClientId and OAuthClientSecret:

1. You will need to reach out to Outreach at platform@outreach.io to request that an OAuth application be provided to you.

Authenticate to from a Desktop Application

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

• OAuthClientId: Set to the client key in your app settings.
• OAuthClientSecret: Set to the client secret in your app settings.
• CallbackURL: Set to the callback URL in your app settings.
• InitiateOAuth: Set to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property.

When you connect, the adapter opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The adapter then completes the following OAuth process:

1. Gets the callback URL and sets the access token.
2. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
3. Exchanges the returned refresh token for a new, valid access token.

Authenticate to from a Web Application

To obtain the access token, set the following connection properties:

• OAuthClientId: Set to the client key in your app settings.
• OAuthClientSecret: Set to the client secret in your app settings.
• CallbackURL: Set to the callback URL in your app settings.

When connecting via a web application, or if the adapter is not authorized to open a browser window, you need to exchange temporary verification values for the access token:

1. Call GetOAuthAuthorizationURL. The stored procedure returns the URL to the OAuth endpoint.
2. Log in and authorize the application. You are redirected back to the callback URL. If you set the GrantType parameter to Implicit, the callbackURL contains the OAuthAccessToken in a query string parameter. If you set the GrantType parameter to code, the callback URL contains the verifier code in the query string parameter named "code". Extract the verifier code and call .

To connect to data, set the following connection properties:

• OAuthAccessToken

To automatically refresh the access token when it expires, set InitiateOAuth to REFRESH and set OAuthRefreshToken. Alternatively, call the RefreshOAuthAccessToken stored procedure when the access token expires. Given a refresh token as input, the procedure returns a valid OAuth access token.