Invoke the Oracle Integration Developer APIs from within an Integration

OAuth is required to use the Oracle Integration Developer APIs. Calling the Oracle Integration Developer APIs from within an integration is common.

For example, you use the scheduling Developer API to run a scheduled integration or the lookups Developer API to view lookups from within your integration.

To call the Oracle Integration Developer APIs from within an integration, you must also configure the OAuth policy in the REST Adapter invoke connection.

An external application or user requests access with IAM, then authenticates with IAM, and invokes the Oracle Integration API.

Configuration Summary

Is OAuth required? Supported authentication types Required roles
Yes. OAuth is required to invoke the Oracle Integration Developer APIs. For supported authentication types for REST Adapter invoke connections, see Authentication Types

The role you assign your confidential client application depends on which APIs you'll be using. If you're creating lookups for example, you'll need the ServiceDeveloper role. For detailed information on each role, see What Users Can Do in the Integrations Design Section by Role.

  • ServiceUser is the minimum role required to call the Developer APIs. This user has access to the Oracle Integration Console as well as the APIs. Assign the ServiceUser role in most cases. This user can also trigger an integration's endpoint.
  • ServiceDeveloper is required if you're invoking the Developer APIs from within an integration or you're using the APIs to perform create operations such as creating lookups or importing an integration.

Configuration Steps

  1. Create a REST Adapter connection
  2. Add the REST Adapter as an Invoke Connection to an Integration
  3. Configure OAuth settings for the invoke connection within the integration.
  4. Use the Design-time URL.
  5. Change the invoke request parameters and add the parameter integrationInstance.
  6. Pass the integrationInstance value in the mapping.
  7. Trigger the integration to invoke the APIs.