Prerequisites for Creating a Connection

You must satisfy the following prerequisites to create a connection with the REST Adapter.

OAuth Security Policies

If you are using one of the OAuth security policies, you must already have registered your client application to complete the necessary fields on the Connections page. The Basic Authentication and No Security Policy security policies are exempted.

Before a client application can request access to resources on a resource server, the client application must first register with the authorization server associated with the resource server.

The registration is typically a one-time task. Once registered, the registration remains valid, unless the client application registration is revoked.

At registration time, the client application is assigned a client ID and a client secret (password) by the authorization server. The client ID and secret are unique to the client application on that authorization server. If a client application registers with multiple authorization servers (for example, Facebook, Twitter, and Google), each authorization server issues its own unique client ID to the client application.

@ref: http://tutorials.jenkov.com/oauth2/authorization.html

For OAuth configuration, read the provider documentation carefully and provide the relevant values.

SSL Endpoints

For SSL endpoints, obtain and upload a server certificate. For more information, see Upload an SSL Certificate.

Amazon Web Services (AWS) REST API Consumption

Before you can create a connection that consumes an Amazon Web Services (AWS) REST API, you must obtain the necessary access and secret keys. See Understanding and Getting Your Security Credentials.

OCI Signature Version 1 Security Policy Use

To configure the REST Adapter to use the OCI Signature Version 1 security policy on the Connections page, you must perform several tasks:
  • Create an API signing key. You then specify the signing key in Oracle Cloud Infrastructure.
    1. Create the signing key in Oracle Cloud Infrastructure using openssl. The key must be in RSA (PKCS1) format. During creation, you also create a pass phase to protect the key. Both the key and pass phrase are required when configuring the OCI Signature Version 1 security policy on the Connections page. See Creating a Key Pair.

      If the key downloaded from the Oracle Cloud Infrastructure Console is in PKCS8 format, it must be converted to RSA (PKCS1) format. See Convert a Private Key from PKCS8 to RSA (PKCS1) Format for the OCI Signature Version 1 Security Policy.

      Existing connections already using the OCI Signature Version 1 security policy do not need to be upgraded because they continue to work.

    2. Sign in to the Oracle Cloud Infrastructure Console to upload the public key.
    3. In the upper left corner, select hamburger menu.
    4. Click Home.
    5. Select Identity & Security, then select Users.
    6. On the Users page, click the link of the user name to use.
    7. In the Resources section, click API Keys.
    8. Click Add API Key.
    9. In the Add API Key dialog, add the public key you created, and click Add.
      The API keys dialog shows a link for Add API Key. Below is a table with the finger print value and the time at which it was created.

    10. Copy the finger print value generated by Oracle Cloud Infrastructure. You need this value when configuring the OCI Signature Version 1 security policy on the Connections page.
  • Obtain the tenancy OCID and user OCID details in the Oracle Cloud Infrastructure Console. When you sign up for Oracle Cloud Infrastructure, Oracle creates a tenancy for your company, which is a secure and isolated partition within Oracle Cloud Infrastructure where you can create, organize, and administer your cloud resources.
    1. Sign in to the Oracle Cloud Infrastructure Console.
    2. In the upper left corner, select hamburger menu, and search for Tenancies.
    3. Click Tenancies.
    4. For your tenancy, go to the Tenancy Information section and click Show to display the OCID tenancy value.
    5. Copy the value. You need this value when configuring the OCI Signature Version 1 security policy on the Connections page.
    6. In the upper right corner, click the Profile icon and select User settings.
      The Profile icon is selected to show the Profile menu. This menu includes links for oracleidentitycloudservice/, Tenancy, Service user Console, User settings, Console settings, and sign out.

      Note:

      You can also select hamburger menu in the upper left corner, then select Identity & Security, and then select User settings to access the user profile.
    7. Click Show to display the OCID user value.
    8. Copy the value. You need this value when configuring the OCI Signature Version 1 security policy on the Connections page.