Authenticate with OAuth

Prerequisites

New to CCDS? See Concept: CCDS and Set up a Custom Cloud Data Source(CCDS).
Required Permissions to Set up and Authenticate a CCDS with OAuth:
Integration Developer
within
Administration > Permission Set
Required Permissions to Request Authorization for a CCDS:
Data Designer
within
Administration > Permission Set
Create a CCDS or select an existing CCDS.

Navigation

From the nav menu, go to

Integration

>

Design Integrations

.

Set up and Configure an OAuth

Select
Create New Credential
in the
Credentials
pane.
Select
OAuth1.0a
or
OAuth 2.0
, enter a name for the credential, and click
Create
. OAuth 1.0a and OAuth 2.0 credentials use different icons for identification purposes..
Fill in the
Settings:
OAuth 1.0a
Settings
has these fields:
Consumer Key:
Client ID or client identifier, issued to the client during registration process. The
Consumer Key
and
Consumer Secret
form the credentials pair for identifying and authenticating the client making a request.
Consumer Secret:
The secret key of the client.
Supported Signature Method:
The pre-defined signature method is "HMAC-SHA1" and cannot be changed.
Request Token Service Http Method:
Select either GET or POST from the dropdown.
Request Token Service Endpoint:
Used by the client to request a set of token credentials.
Authorize Redirect URL:
URL to obtain the temporary credentials for delegation request identification.
Access Token Service HTTP Method:
Select either GET or POST according to the external access token service requirements.
Access Token Service Endpoint:
URL to fetch the token for accessing protected resources.
Add OAuth Params to Request URLs:
URL to identify a resource within the scope of the URI's scheme and naming authority.
OAuth 2.0
Settings
has these additional fields:
Consumer Key:
Client Id or client identifier, issued to the client during registration process. The
Consumer Key
and
Consumer Secret
form the credentials pair for identifying and authenticating the client making a request.
Consumer Secret:
The secret key of the client.
Redirect URI:
Redirect the user after authorization. The Integration developer uses this URI during the OAuth 2.0 application setup on the third party server.This field cannot be changed.
Scope:
The scope of services or objects for authorization access requests.
Authorization Header Required:
Select this checkbox if the third party service provider requires the authorization header in the request when requesting or refreshing the access token after authorization.
Access Token Renewable:
Select this checkbox if the initial authorization process fetches the original access and refresh tokens for renewal, and if the access token on the third party server renews automatically.
Authorize Redirect URL
: The URL to obtain the temporary credentials for delegation request identification.
Access Token Service Http Method
: Select either GET or POST according to the external access token service requirements.
Access Token Service Endpoint
: URL to fetch the token for accessing protected resources.
Token Expiry Default (sec):
Default expiration in seconds for access tokens without an expiry time.
Click
Save
in the
Actions
pane.

Authenticate your CCDS with OAuth

Select your CCDS in the
Data Sources
pane.
Select
Requires Credentials
in the
Data Settings
tab.
Choose your OAuth credential from the
Credentials
dropdown.
Update your script in the
Scripts
tab to include your OAuth credential. For example,
response=ai.authorizedRequest(url,method,body,headers)
.
Click
Save
in the
Actions
pane.

Request Authorization

Select your CCDS in the
Data Sources
pane.
Select
Request Authorization
in the
Actions
pane to generate the CCDS Authorization Request.
A new browser window opens for authorizing the third party website. After the authorization is complete, the OAuth 1.0a application connects to your account to access data. For OAuth 2.0, if the third party website allows, it may indicate the full scope of services you provided in the OAuth 2.0
Settings -
Scope
field.
Refresh the
Adaptive Planning
CCDS Data Sources page. Notice that all the menu items in the
Actions
pane become enabled.