TIBCO Scribe® Online Using Custom Authentication for a REST connection

TIBCO Scribe® Online Using Custom Authentication for a REST connection

book

Article ID: KB0076385

calendar_today

Updated On:

Products Versions
TIBCO Cloud Integration - Connect ( Scribe ) -

Description

This example is using the Cornerstone Edge API. In order to make an API call, the Rest connector must provide a client ID and secret to the authorization server in order to receive an access token.
The screen shots below are from the Cornerstone Edge documentation.

Here is the curl example for requesting a token
User-added image
If the request is valid a token is returned
User-added image

Issue/Introduction

Rest Web Services often utilize token based authentication. This article discusses how to utilize the Custom OAuth authentication in the REST connector.

Environment

TIBCO Scribe® Online

Resolution

The screen shots below show how to implement the token based authentication in the TIBCO Scribe® Online REST connection

In the Authentication tab select Custom OAuth and specify the Access Token URL
Set the appropriate Content Encoding  (e.g. application/x-www-form-urlencoded or application/json)

User-added image

Specify the appropriate values such as Client ID, Client Secret, etc.
Which values to specify and the location (Content, Header, Query) is determined by the API authentication rules
Often the API documentation will provide Curl examples that indicate what is required as shown above

User-added image

The connection should always specify a Refresh Request unless the token will never expire.
If  the API utilizes a Refresh token input the appropriate values.
If not, repeat the same values specified in the Authentication Request Input Settings section.

User-added image

This API utilizes a Bearer token - fill in the appropriate values.
User-added image

** Note:
    The REST connector ignores authentication settings in the swagger used in the connection.
    However, as of the writing of this article, there is a defect (SCREST-206) where Header parameters are not getting ignored and cause errors in the connection.
    In order for the REST connection to work properly the Header parameters must be removed from the swagger - see example below

User-added image