Invoke Oracle Integration Developer APIs from an External Client

OAuth is required to use the Oracle Integration Developer APIs. An external application or user requests access from IAM, then authenticates with IAM, and invokes the Oracle Integration Developer API.

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

Configuration Summary

Is OAuth required?	Supported grant types	Required roles
Yes. OAuth is required for all Oracle Integration Developer APIs.	The grant types you can use are the same as that for the REST Adapter: JWT User Assertion Authorization code Client credentials Resource Owner Password Credentials (not recommended) See About OAuth 2.0 Grants for more details on each grant type and which one to use.	The role you assign your confidential client application depends on which APIs you'll be using. Assign the highest role required for your specific use case. 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. 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. Use ServiceInvoker if you only need to invoke an integration's endpoint and will not be making any calls to the Oracle Integration Developer APIs.

Is OAuth required?

Supported grant types

Required roles

Yes. OAuth is required for all Oracle Integration Developer APIs.

The grant types you can use are the same as that for the REST Adapter:

JWT User Assertion
Authorization code
Client credentials
Resource Owner Password Credentials (not recommended)

See About OAuth 2.0 Grants for more details on each grant type and which one to use.

The role you assign your confidential client application depends on which APIs you'll be using. Assign the highest role required for your specific use case.

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.
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.
Use ServiceInvoker if you only need to invoke an integration's endpoint and will not be making any calls to the Oracle Integration Developer APIs.

Configuration Steps

Note:

You must be the OCI tenant and domain administrator to configure the confidential client application and assign roles.

Create the confidential client application, assign scopes and roles, and activate it:

Access the Identity Domain.
Configure prerequisites for your grant type:
Call the Developer APIs using a client such as Postman or cURL: