Configuring the MuleSoft Connector

Configuring the MuleSoft Connector

Liferay’s connector to MuleSoft uses OpenAPI 3.0 documents that describe Liferay’s APIs. Each OpenAPI document is deployed dynamically in your Liferay instance under the following schema:


These documents are based on your deployed RESTful web services, so they are the most accurate descriptions of your APIs. You can learn more about Liferay APIs here.

Once you specify an OpenAPI document endpoint, the connector automatically configures the paths, path/query parameters, and entity metadata defined in the OpenAPI document. The connector works with any OpenAPI 3.0 document that follows Liferay standards and supports all Liferay APIs.

Adding the Connector to Mule Projects

Before configuring the connector, you must add it to your Mule project:

  1. Click Search in Exchange in the Mule Palette.

  2. Search for Liferay.

  3. Select the connector and click Add.

  4. Click Finish.

The connector now appears in your Mule project.

Set the Client Profile as Headless Server in the OAuth2 configuration.

Connector Configuration

  1. Select an authentication method and enter the required parameters.

  2. Specify an OpenAPI document endpoint.


Choose between Basic and OAuth2 authentication methods.

Basic Authentication: Enter a user name and password.

OAuth2: Enter a client key and client secret.

For production, you should authorize users via OAuth2. Basic authentication is provided only for basic testing and demonstration.

When setting up OAuth2 in Liferay, select Headless Server for Client Profile. Liferay generates a client ID (consumer key) and client secret (consumer secret) for use in the connector.

Set the Client Profile as Headless Server in the OAuth2 configuration.

To use endpoints with OAuth2 authorization, you must also define scopes with the authorization options you need (e.g., everything, everything.write, or

See Creating OAuth2 Applications for detailed setup instructions, or Using OAuth2 to Authorize Users for a sample React application with OAuth2.

Specify OpenAPI Document Endpoint

Once authorized, set an OpenAPI document endpoint to specify the Liferay API you want to use. For example, this document is for the Commerce Admin Catalog API:


To set this value, edit the Liferay_Config global element and enter the document endpoint into the OpenAPI Spec URL field.

Enter the OpenAPI document endpoint in the Open API Spec URL field.

You can also do this using XML configuration. Right click the Liferay_Config global element and select Go to XML. Then enter your credentials using the appropriate format for your authentication method.

  • Basic Authentication Example:

     <liferay:config name="Liferay_Config_Catalog">
     <liferay:basic-connection username=${username} password=${password} openApiSpecPath="http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/openapi.json" />
  • OAuth 2.0 Example:

     <liferay:config name="Liferay_Config_Catalog">
     <liferay:oauth2-connection consumerKey="${consumerKey}" consumerSecret=${consumerSecret} openApiSpecPath="http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/openapi.json" />

Click Test Connection. If successful, you can start building flows using the connector. Otherwise, review your configuration.

Additional Information