Create a Connection
Before you can build an integration, you must create the connections to the applications with which you want to share data.
Note:
You can also create a connection in the integration canvas. See Define Inbound Triggers, Outbound Invokes, and Actions.To create a connection in Oracle Integration:
- Decide where to start:
- Work in a project (see why working with projects is
preferred).
- In the navigation pane, click Projects.
- Select the project name.
- Click Integrations
.
- In the Connections section, click Add if no connections currently exist or + if connections already exist. The Create connection panel opens.
- Work outside a project.
- In the navigation pane, click Design, then Connections.
- Click Create. The Create connection panel opens.
- Work in a project (see why working with projects is
preferred).
-
Select the adapter to use for this connection. To find the adapter, scroll through the list, or enter a partial or full name in the Search field.
-
Enter the information that describes this connection.
Element Description Name Enter a meaningful name to help others find your connection when they begin to create their own integrations.
Identifier Automatically displays the name in capital letters that you entered in the Name field. If you modify the identifier name, don't include blank spaces (for example,
SALES OPPORTUNITY
).Role Select the role (direction) in which to use this connection.
Note: Only the roles supported by the adapter you selected are displayed for selection. Some adapters support all role combinations (trigger, invoke, or trigger and invoke). Other adapters support fewer role combinations.
When you select a role, only the connection properties and security policies appropriate to that role are displayed on the Connections page. If you select an adapter that supports both invoke and trigger, but select only one of those roles, you'll get an error when you try to drag the adapter into the section you didn't select.
For example, assume you configure a connection for the Oracle Service Cloud (RightNow) Adapter as only an invoke. Dragging the adapter to a trigger section in the integration produces an error.
Keywords Enter optional keywords (tags). You can search on the connection keywords on the Connections page.
Description Enter an optional description of the connection.
Share with other projects Note: This field only appears if you are creating a connection in a project.
Select to make this connection publicly available in other projects. Connection sharing eliminates the need to create and maintain separate connections in different projects.
When you configure an adapter connection in a different project, the Use a shared connection field is displayed at the top of the Connections page. If the connection you are configuring matches the same type and role as the publicly available connection, you can select that connection to reference (inherit) its resources.
-
Click Create.
Your connection is created. You're now ready to configure the connection properties, security policies, and (for some connections) access type.
- Follow the steps to configure a connection.
The connection property and connection security values are specific to each adapter. Your connection may also require configuration with an access type such as a private endpoint or an agent group.
- Test the connection.
Configure Connection Properties for Invoke Connections
Configure connection security to invoke a protected target service with the REST Adapter.
Configure Connection Security
Configure security for your REST Adapter connection by selecting the security policy and specifying the required details.
- Go to the Security section.
- Select the security policy to use. If you selected the
Invoke role or the Trigger and
Invoke role during REST Adapter connection creation, the page is refreshed to display various login
credential fields. You must already have created your client application to
complete the necessary fields.
The following security policy restrictions apply when configuring a REST Adapter connection with the trigger and invoke role on the Connections page:
- If you select Basic Authentication, it can be used as a trigger and an invoke.
- If you select any other security policy, it can only be used as an invoke. Dragging the connection to the trigger area causes an exception error to be displayed.
- For existing integrations, the above restrictions do not apply when editing the REST Adapter in the Adapter Endpoint Configuration Wizard.
Note:
The following standard OAuth security policies are implemented to work with providers that are implemented as illustrated in RFC 6749.- OAuth Resource Owner Password Credentials
- OAuth Client Credentials
In case the standard policy doesn't work, it is recommended that you use the OAuth Custom Two Legged or OAuth Custom Three Legged security policy.
Configure Security Policies for Trigger Connections
Selected Security Policy | Description | Fields |
---|---|---|
OAuth2.0 |
See Authenticate Requests for Invoking Oracle Integration Flows. |
No fields are displayed. |
Basic Authentication |
|
No fields are displayed. |
OAuth 2.0 or Basic Authentication | The client can use any of the OAuth 2.0 bearer tokens or the HTTP Basic Authentication header. | No fields are displayed. |
Configure Security Policies for Invoke Connections
Note:
OAuth Authorization Code Credentials, OAuth Custom Three Legged Flow, and OAuth Custom Two Legged Flow security types, the connection is only successful after you click the Provide Consent button. Configuring all the details alone is not sufficient.Note:
Testing a REST Adapter connection configured with the HTTP basic authentication security policy and a role connection of Trigger and Invoke or Invoke does not validate the credentials and simply opens a connection to the provided URL. To validate the endpoint and credentials, the REST Adapter must invoke an API that is idempotent.Selected Security Policy | Fields |
---|---|
AWS Signature Version 4 Note: You can use this security policy with the connectivity agent for scenarios in which you need to invoke AWS APIs hosted in an on-premises environment. |
|
Basic Authentication |
|
OAuth Client Credentials |
|
OAuth Resource Owner Password Credentials |
|
OAuth Authorization Code Credentials |
|
OAuth Custom Three Legged Flow See Configure the REST Adapter to Consume a REST API Protected with OAuth Custom Three Legged Flow Token-Based Authentication to learn more about this security policy. |
|
OAuth Custom Two Legged Flow See Configure the REST Adapter to Consume a REST API Protected with OAuth Custom Two Legged Token-Based Authentication to learn more about this security policy. |
|
API Key Based Authentication See Configure the REST Adapter to Consume a REST API Protected with the API Key to learn more about this security policy. |
|
OAuth 1.0 One Legged Authentication |
Note: The HMAC-SHA256 signature encryption algorithm is supported by default and cannot be changed. HMAC-SHA1 is not supported in Oracle Integration 3. |
OCI Signature Version 1 | Specify the values you created when satisfying the
prerequisites for using this security policy. See Prerequisites for Creating a Connection.
|
OAuth Client Credentials using JWT Client Assertion Note: This policy is typically used to invoke application-driven APIs. |
|
OAuth using JWT User Assertion Note:
|
|
OCI Service Invocation |
After selecting this security policy, you are not prompted to specify any values. Configuration is automatic. However, you must perform all prerequisites for configuration to succeed. |
No Security Policy |
If you select this security policy, no additional fields are displayed. |
Variations of JWT Usage by Service Providers
Service providers implement JWT assertions in different ways, including how to specify the scope value and an access token request value in the Scope and Access token request fields when configuring the OAuth Client Credentials using JWT Client Assertion or OAuth using JWT User Assertion security policy on the Connections page.
Service Provider | Requires Provide Consent? | Scope and Access token request Fields on Connections Page | Reference Documentation |
---|---|---|---|
Okta | No |
|
Implement OAuth for Okta with a service app |
Okta | Yes |
POST /token HTTP/1.1 Host: server.example.com Content-Type: application/x-www-form-urlencoded grant_type=authorization_code& code=<id_token>& client_id=<client_id> client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer& client_assertion=<client_assertion> |
JWT with private key |
NHS | no |
|
Application-restricted RESTful APIs - signed JWT authentication |
NHS | Yes |
|
Step 4: Register your public key User-restricted RESTful APIs - NHS login separate authentication and authorization |
FHIR | No |
|
Using OAuth 2.0 |
FHIR | Yes |
|
Standalone Launch |
Microsoft | No |
|
Microsoft identity platform and the OAuth 2.0 client credentials flow |
Microsoft | Yes |
|
Microsoft identity platform and OAuth 2.0 On-Behalf-Of flow |
DocuSign | Yes |
|
How to get an access token with JWT Grant |
Adobe | No |
|
JWT (Service Account) Authentication |
Oracle Identity Cloud Service | No |
|
Client/User JWT Assertion in REST API for Oracle Identity Cloud Service. |
Oracle Identity Cloud Service | No |
|
Client/User JWT Assertion in REST API for Oracle Identity Cloud Service. |
Configure the Endpoint Access Type
Configure access to your endpoint. Depending on the capabilities of the adapter you are configuring, options may appear to configure access to the public internet, to a private endpoint, or to an on-premises service hosted behind a fire wall.
Select the Endpoint Access Type
- Go to the Access type section.
- Select the option for accessing your endpoint.
Option This Option Appears If Your Adapter Supports ... Public gateway Connections to endpoints using the public internet. Private endpoint Connections to endpoints using a private virtual cloud network (VCN). Note: To connect to private endpoints, you must complete prerequisite tasks in the Oracle Cloud Infrastructure Console. Failure to do so results in errors when testing the connection. See Connect to Private Resources in Provisioning and Administering Oracle Integration 3 and Troubleshoot Private Endpoints in Using Integrations in Oracle Integration 3.
Connectivity agent Connections to on-premises endpoints through the connectivity agent.
-
Click Associate agent group.
The Associate agent group panel appears.
-
Select the agent group, and click Use.
To configure an agent group, you must download and install the on-premises connectivity agent. See Download and Run the Connectivity Agent Installer and About Creating Hybrid Integrations Using Oracle Integration in Using Integrations in Oracle Integration 3.
-
Ensure Private Endpoint Configuration is Successful
- To connect to private endpoints, you must complete prerequisite tasks in the Oracle Cloud Infrastructure Console. Failure to do so results in errors when testing the connection. See Connect to Private Resources in Provisioning and Administering Oracle Integration 3.
- When configuring an adapter on the Connections page to connect to endpoints using a private network, specify the fully-qualified domain name (FQDN) and not the IP address. If you enter an IP address, validation fails when you click Test.
- IPSec tunneling and FastConnect are not supported for use with private endpoints.