Skip to main content
Adaptive Insights
Knowledge and Support - Adaptive Insights

Working with OAuth

During CCDS creation, Integration Developers must choose between requiring OAuth or not. If OAuth is required, the OAuth service must first be defined by creating credentials for it. An OAuth configuration for a data source is enabled by creating one in the Credentials area of the component library, then associating that credential with the data source. Once credentials are defined, any Data Designer attempting to use that CCDS must log in and authorize the Integration Developer's application to access the data from the specified OAuth service provider's API.

Creating Credentials

OAuth configurations are created and managed under the Credentials area in the Component Library.

  1. Click Create New Credential in the Credentials area.

CCDS - Create Credentials

  1. Select OAuth1.0a or OAuth 2.0, and give the credential a name.

The icons for OAuth 1.0a and OAuth 2.0 are different to make distinguishing the types easier after you give them a name.

CCDS - Credentials - Select template

  1. Click Create
  2. For OAuth 1.0a, fill in the fields needed by the OAuth 1.0a provider you are using:
    • Consumer Key: This is also called the Client Id or client identifier, which is issued to the client during the registration process. The consumer key along with the consumer secret form a credentials pair. This credentials pair is used to identify and authenticate the client making the request. This is a required field.
    • Consumer Secret: The client secret, which together with the consumer key forms the credentials pair. This is a required field.
    • Supported Signature: This field cannot be edited.
    • Request Token Service Method: Select the method, either GET or POST.
    • Authorize Redirect URL: The URL to get the temporary credentials to identify the delegation request.
    • Access Token HTTP Method: Select the method, either GET or POST.
    • Access Token Service Endpoint: This is the URL to get the token needed to access the protected resources.
    • More details can be found on the IETF website - https://tools.ietf.org/pdf/rfc5849.pdf

CCDS - Credentials - OAuth 1.0 Settings

  1. For OAuth 2.0, fill in the fields needed by the OAuth 2.0 provider you are using:
    • Consumer Key: This is also called the Client Id or client identifier, which is issued to the client during the registration process. The consumer key along with the consumer secret form a credentials pair. This credential pair is used to identify and authenticate the client making the request. This is a required field.
    • Consumer Secret: This is the client secret, which together with the consumer key forms the credentials pair. This is a required field.
    • Redirect URI: For OAuth 2.0, the application configuration on the third party server requires a redirect URI it can redirect the user to after the user has authorized the application. The Integration developer needs to use this URI to complete their OAuth 2.0 application setup on the third party server. This field cannot be edited.
    • Scope: The scope of services or objects the authorization can request access to.
    • Authorization Header Required: This field determines if the third party service provider expects the Authorization header included in the request when requesting or refreshing Access Token after the user has authorized the application.
    • Access Token Renewable: Determines if the access token can be renewed on the third party server without user presence after the initial authorization has been granted. This presumes that the original access token was acquired along with a refresh token for renewal.
    • Access Token HTTP Method: Select method - one of GET or POST.
    • Access Token Service Endpoint: This is the URL from which the token needed to access the protected resources is acquired.
    • More details can be found on the IETF website - https://tools.ietf.org/pdf/rfc6749.pdf

CCDS - Credentials - OAuth2.0 Settings

  1. Click Save in the Actions menu.

OAuth 1.0a Workflow  

  1. An Integration Developer begins the CCDS creation process and chooses Require OAuth in the CCDS Authorization Dialog the first time a new CCDS is being built.
  2. An OAuth 1.0a credential is chosen from the Require OAuth dialog dropdown, and CCDS creation process continues, including writing the JavaScript in the Scripts tab of the Data Designer screen.

CCDS - OAuth 1.0a - Script

  1. Once the CCDS is created, Data Designers who choose to access an OAuth CCDS data source cannot access any of the action buttons on the Data Designer screen except Request Authorization.
  2. The Data Designer clicks Request Authorization.

CCDS - OAuth 1.0a - Request Authorization

  1. A CCDS Authorization Request dialog appears.

CCDS - OAuth 1.0a - Authorization Dialog

  1. Clicking OK launches a new browser window for authorizing on the third party website.

CCDS - OAuth 1.0a - Browser Window - 3rd Party Login
CCDS - OAuth 1.0a - Browser 3rd Party Authorization

  1. Once the third party authorization is completed, the OAuth 1.0a application connects to their account to access their data.

CCDS - OAuth 1.0 - Authorization Complete

  1. After authenticating with the OAuth 1.0a service, and reloading the data source, all of the data source specific actions (Test Connection, Import Structure, Import Data) in the Data Designer screen become enabled.

CCDS - OAuth 1.0a - Authorization Status

  1. The Data Source Settings tab indicates Authorization Status showing the ID used to authorize on the third party site, and the date of the authorization. Authorization expiration dates vary from one provider to another. Make a note of when your authorization will expire.

CCDS - OAuth 1.0a - Authorization Status Indicators

Click the Reset Authorization button in the Actions pane to re-authorize when needed.
The Reset Authorization Button can also be used to provide different authorization credentials to the third party website.

OAuth 2.0 Workflow

  1. An Integration Developer begins the CCDS creation process and chooses Require OAuth in the CCDS Authorization Dialog the first time a new CCDS is being built.
  2. An OAuth 2.0 credential is chosen from the Require OAuth dialog dropdown, and the CCDS creation process continues, including writing the JavaScript in the Scripts tab of the Data Designer screen.

CCDS - OAuth 2.0 - Script

  1. Once the CCDS is created, Data Designers who choose to access an OAuth 2.0 CCDS data source cannot access any of the action buttons on the Data Designer screen except Request Authorization.

CCDS - OAuth 2.0 - Request Authorization

  1. The Data Designer clicks Request Authorization.
  2. A CCDS Authorization Request dialog appears.

CCDS - OAuth 2.0 - Request Authorization Dialog

  1. Clicking OK launches a new browser window for authorizing on the third party website. If the third party website allows, it may indicate the full scope of services you provided in the OAuth Provider Settings' Scope field.

​​​​​​​CCDS - OAuth 2.0 - Browser Third Party Authorization

  1. Once the third party authorization is completed, the OAuth 2.0 application connects to their account to access their data.

​​​​​​​​​​​​​​CCDS - OAuth 2.0 - Authorization Request Complete

  1. After authenticating with the OAuth 2.0 service, and reloading the data source, all of the data source specific actions (Test Connection, Import Structure, Import Data) in the Data Designer screen become enabled.

​​​​​​​​​​​​​​CCDS - OAuth 2.0 - Authorization Status

  1. The Data Source Settings tab indicates Authorization Status showing the ID used to authorize on the third party site, and the date of the authorization. Authorization expiration dates vary from one provider to another. Make a note of when your authorization will expire.

​​​​​​​​​​​​​​CCDS - OAuth 2.0 - Authorization Status - Reauthorize

Click the Reset Authorization button in the Actions pane to re-authorize when needed.
The Reset Authorization button can also be used to provide different authorization credentials to the third party website.
 

  • Was this article helpful?