Description

n8n Liferay Node

Liferay node for the n8n workflow automation tool

Features

• Authentication via OAuth2 or Basic Auth
• Easily interact with Custom Liferay Objects in the GUI
• All endpoints from REST Applications available via Autocomplete

All operations and parameters of the Headless APIs are made available via the OpenAPI definitions available from Liferays Headless APIs.

Prerequisites

• n8n
• Liferay DXP 7.4+

Installation

Follow the installation guide in the n8n documentation.

Authentication

Basic Auth

Authentication via Basic Auth is available by default in Liferay. The user you’re authenticating with needs to have the appropriate permissions for the API actions you want to perform.

OAuth 2

In Liferay, set up a new OAuth 2 Application under Control Panel – Security – OAuth 2 Administration. Keep the default settings, but only enable Client Credentials for the Allowed Authorization Types and choose the User the client will impersonate.
After saving the application, open the Scopes tab and enable the following in addition to the Scopes needed for your use case:

• Liferay.Headless.Discovery.OpenAPI – Read data on your behalf (required to list all available OpenAPI definitions and endpoints)
• Liferay.Object.Admin.REST – Read data on your behalf (required to list your Object Definitions and available actions)

Go back to the Credentials tab and copy the Client ID and Client Secret into the n8n OAuth2 Credential and set Access Token URL to {{LiferayHostname}}/o/oauth2/token, replacing {{LiferayHostname}} with the hostname of your Liferay instance.

Usage

Headless API Endpoint

All Headless API operations are listed (similar to Liferays API Explorer) and can be selected using autocomplete fields:

1. Select the REST Application (i.e. headless-admin-user/v1.0)
2. Select the endpoint (i.e. /v1.0/my-user-account)
3. Select the method name (i.e. GET)
4. Enter additional values in the fields below if needed

Object Operation

While you can perform operations of Liferay Objects using the Headless API endpoints above, this offers a cleaner, filtered view of the available operations without having to choose the method separately:

1. Select the Object Defintion Name (i.e. SampleObject)
2. Select the Operation Name (i.e. getSampleObjectsPage)
3. Enter additional values in the fields below if needed

Using the Execute step button on top you can test if the request is successful and the expected data is returned.

Video

Watch the YouTube video for a n8n intro and overview of the Liferay Node.

Screenshots

!n8n Screenshots