Bearer Authentication Scheme Setup

Bearer authentication type is fully supported by the integration framework. This page is a guide to set up the JSON schema of any connector to use the bearer authentication token of the OpenAPI 3.0 Swagger.

Setting Up the Bearer Authentication Scheme for a Connector

To proceed with setting up the connector/integration system to support the bearer token as a means for authentication, go to BSS Setup → Administration → System Options → Systems Setup. Then, either activate one of the available connectors before setting it up, or choose from the list of the enabled connectors.

By selecting Edit Integration for an enabled connector, the following page is displayed. It contains the schemas that the Bearer Token field must be added to, along with its back-end functionality on the Settings page of the Connector.

Proceed with the following changes in the JSON Definition schema tree:
(Alternatively, you may follow the guide here: )

A. First, you need to define the object under components/securitySchemes:

  1. Expand the securitySchemes object and rename the underlying object to bearerAuth.
  2. Afterwards, expand the bearerAuth object and create (if they don’t already exist) three strings, exactly as the ones that follow below:
    1. type:http
    2. scheme:bearer
    3. description:Bearer Token

B. Then, you need to define the array under security:

Expand the security array, then expand the 0 object and rename the underlying array to bearerAuth and leave it empty.

C. Finally, you select Save or Save & Close.

After the changes have been saved, you are redirected to the list of enabled connectors.

By selecting Settings you are redirected to the connector instance settings page.

Here, you the Bearer Token field has been successfully created.