Platform - Liferay Learn

Configuring Liferay Authentication With PingOne Using SAML

This recipe guides you through the basic steps needed to integrate PingOne, your Identity Provider (IdP), with your Liferay environment using Security Assertion Markup Language (SAML). PingOne...

Published Date: Aug 2, 2024 2:34 PM

Integrate Azure AD with Liferay DXP Using OpenID Connect

This recipe guides you through the basic steps needed to integrate Azure AD (now known as Microsoft Entra ID), your Identity Provider (IdP), with your Liferay environment using OpenID Connect....

Published Date: Aug 2, 2024 4:36 PM

Integrate Azure AD with Liferay DXP Using SAML

As a general best practice, integrating Liferay DXP with other Identity Providers (IdPs) provides enhanced security and streamlines authentication management. This recipe guides you through the...

Published Date: Aug 5, 2024 5:12 PM

Getting Started

Official Documentation

Getting Started Liferay DXP is a powerful, open source, enterprise-ready platform for building and deploying web applications. However, all of that power and functionality can make it difficult to...

Published Date: May 9, 2024 6:51 PM

Introduction to the Admin Account

Official Documentation

Introduction to the Admin Account The Admin User account is created by default in any new installation of Liferay DXP and has full permissions to modify every facet of a Liferay DXP instance. The...

Published Date: May 9, 2024 6:51 PM

DXP

Official Documentation

DXP Welcome to the official documentation for the latest versions of Liferay DXP and Liferay Portal! Liferay DXP is the commercially supported and enterprise ready platform used around the world,...

Published Date: Nov 22, 2024 10:49 PM

Navigating DXP

Official Documentation

Navigating DXP Liferay DXP's out-of-the-box navigation is organized into three major areas: Site Menu, Personal Menu, and Global Menu. Site Menu The DXP Site Menu on the left side of the screen...

Published Date: May 9, 2024 6:51 PM

API Builder

Official Documentation

API Builder Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) This feature is currently...

Published Date: May 9, 2024 6:51 PM

Building a Sample API Application

Official Documentation

Building a Sample API Application Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) The...

Published Date: May 9, 2024 6:51 PM

Captcha API Basics

Official Documentation

Captcha API Basics Liferay provides a headless API to retrieve and submit captchas using the SimpleCAPTCHA engine. Using the /captcha endpoint from the API Explorer, you can add captchas in your...

Published Date: May 9, 2024 6:52 PM

SCIM Group API Basics

Official Documentation

SCIM Group API Basics Liferay DXP 2024.Q1+/Portal GA112+ Liferay provides a headless API to perform CRUD operations on SCIM groups to keep their information in sync with your company's...

Published Date: May 9, 2024 6:52 PM

Workflow Definition Link API Basics

Official Documentation

Workflow Definition Link API Basics Liferay DXP 2025.Q1+/Portal GA132+ You can manage workflow definition links from the Liferay UI or using Liferay's REST APIs. In Liferay, the Control Panel →...

Published Date: Feb 19, 2025 12:28 PM

API Headers Reference

Official Documentation

API Headers Reference API headers are components of HTTP requests that provide essential information to the server about the client's request and how the server should handle it. You can use API...

Published Date: May 9, 2024 6:51 PM

Consuming APIs

Official Documentation

Consuming APIs APIs, or Application Programming Interfaces, serve as the bridge between different software applications, allowing them to communicate and exchange data. By consuming external APIs,...

Published Date: May 9, 2024 6:51 PM

API Query Parameters

Official Documentation

API Query Parameters Whether you consume REST APIs or GraphQL APIs, different query parameters are available to help you filter the responses. Fields Parameter Use this parameter to specify and...

Published Date: May 9, 2024 6:51 PM

Batch Engine API Basics - Exporting Data

Official Documentation

Batch Engine API Basics - Exporting Data Liferay's Headless Batch Engine provides REST APIs to import and export data. Call these services to export data from Liferay. Exporting Data Then,...

Published Date: May 9, 2024 6:51 PM

Configuring JSON Web Services

Official Documentation

Configuring JSON Web Services Liferay’s services are exposed as JSON web services out-of-the-box. This is enabled by default. You can access these services via the API page at...

Published Date: Nov 16, 2024 3:32 PM

Batch Engine API Basics - Importing Data

Official Documentation

Batch Engine API Basics - Importing Data Liferay's Headless Batch Engine provides REST APIs to import and export data. Call these services to import data to Liferay. Importing Data Then follow...

Published Date: May 9, 2024 6:51 PM

Consuming GraphQL APIs

Official Documentation

Consuming GraphQL APIs Liferay DXP contains GraphQL APIs for most of its applications. Here's how to consume them in three steps: Identify the API you wish to consume. Identify the site...

Published Date: May 9, 2024 6:51 PM

Consuming REST Services

Official Documentation

Consuming REST Services Liferay DXP contains REST services for most of its applications. These services are fully OpenAPI compliant. Here, learn how to consume them. This takes only three steps: ...

Published Date: May 9, 2024 6:51 PM

Data Migration Center

Official Documentation

Data Migration Center Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../../../../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) Currently,...

Published Date: May 9, 2024 6:51 PM

Making Unauthenticated Requests

Official Documentation

Making Unauthenticated Requests By default, Liferay DXP restricts API access for the sake of security, requiring authentication to get a valid response. However, in certain cases it may make sense...

Published Date: May 9, 2024 6:51 PM

Using External Reference Codes

Official Documentation

Using External Reference Codes Liferay DXP/Portal 7.4+ Many of Liferay's headless API endpoints support an external reference code (ERC). The ERC field is useful in wide range of scenarios. For...

Published Date: May 9, 2024 6:51 PM

Authorizing Account Access with OAuth2

Official Documentation

Authorizing Account Access with OAuth2 Once you have an application registered, you can start authorizing users. To do that, you must construct the URL to the authorization server (Liferay DXP)....

Published Date: Nov 22, 2024 10:48 PM

Creating an OAuth2 Application

Official Documentation

Creating an OAuth2 Application When you have an application that can use OAuth 2.0 for authorization, you must register that application so Liferay can recognize it. Open the Global Menu...

Published Date: Nov 22, 2024 10:48 PM

Issuing JWT Access Tokens

Official Documentation

Issuing JWT Access Tokens Liferay DXP 7.4 U45+/GA45+ You can configure Liferay to issue access tokens in the JWT format from System Settings. Enabling JWT Tokens Open the Global Menu...

Published Date: Feb 25, 2025 12:39 PM

Sample API Tutorials

Official Documentation

Sample API Tutorials Follow the links below for sample API tutorials that include example requests and example code. Building Applications (Objects) Custom Objects API Basics Custom Objects...

Published Date: May 9, 2024 6:51 PM

Using OAuth 2.0

Official Documentation

Using OAuth 2.0 OAuth 2.0 is an industry-standard authorization protocol. Users with accounts on a Liferay-based website can share select credentials with various clients seamlessly. OAuth 2.0...

Published Date: May 9, 2024 6:51 PM

Using Private Key JWT (JSON Web Token)

Official Documentation

Using Private Key JWT (JSON Web Token) Liferay supports private key JWT as an authentication method for OAuth 2 clients. In this flow, the client itself creates the assertion. Liferay authenticates...

Published Date: Mar 6, 2025 4:05 PM

JSON Web Token Assertions

Official Documentation

JSON Web Token Assertions An assertion helps in sharing identity and security information across different domains. There are two uses for assertions: Authorization grants Client authentication...

Published Date: Feb 25, 2025 12:39 PM

Configuring the JWT Bearer Flow

Official Documentation

Configuring the JWT Bearer Flow To use JWT Bearer as a grant type in Liferay, you must create an OAuth 2 client with the Client Authentication Method set to Client Secret Basic or Post. The client...

Published Date: Feb 25, 2025 12:39 PM

JSON Web Tokens (JWTs)

Official Documentation

JSON Web Tokens (JWTs) JSON Web Tokens (JWTs) represent encoded data. They are compact, self-contained, and secure. There are two primary types of JSON Web Tokens: Encrypted JWT: ensures the...

Published Date: Feb 25, 2025 12:39 PM

OAuth 2 Scopes

Official Documentation

OAuth 2 Scopes In OAuth 2.0, applications are granted access to limited subsets of user data. These are called scopes (not to be confused with Liferay scopes). You can create them in two ways: ...

Published Date: Nov 22, 2024 10:48 PM

Producing and Implementing APIs with REST Builder

Official Documentation

Producing and Implementing APIs with REST Builder With REST Builder, you can define the API you want to build, and REST Builder provides the framework and endpoints for you. Deploy an Example REST...

Published Date: May 9, 2024 6:51 PM

Using OAuth2 to Authorize Users

Official Documentation

Using OAuth2 to Authorize Users You can create applications that access Liferay's headless REST APIs using the OAuth 2.0 authorization protocol. The provided sample React app demonstrates three...

Published Date: Nov 22, 2024 10:48 PM

REST Builder

Official Documentation

REST Builder REST Builder is a code generation tool that makes it easy for you to take your local APIs and make them available on the web. It uses the OpenAPI Specification to generate REST and...

Published Date: May 9, 2024 6:51 PM

Low Code

Official Documentation

Low Code

Published Date: May 9, 2024 6:55 PM

Calling Liferay APIs from Camunda

Official Documentation

Calling Liferay APIs from Camunda The Liferay Connector enables calling Liferay APIs from your Camunda tasks. It's a protocol connector built on top of the Camunda HTTP REST connector. Follow...

Published Date: Jun 26, 2025 6:24 PM

Using Camunda Business Processes

Official Documentation

Using Camunda Business Processes Liferay 7.4+, and all quarterly releases Liferay's native workflow features are designed for business processes requiring basic review and approval. If your...

Published Date: Jun 4, 2025 6:31 PM

Triggering Events in Camunda with Liferay Webhooks

Official Documentation

Triggering Events in Camunda with Liferay Webhooks You can send payloads from Liferay's webhook object actions to your Camunda process instances. This enables inbound communication from Liferay to...

Published Date: Jun 26, 2025 6:24 PM

Forms

Official Documentation

Forms The Forms application is in maintenance mode as of Liferay DXP 2024.Q4/Portal GA129. Migrate your forms to objects and form container fragments to future-proof your solutions. You can use...

Published Date: May 9, 2024 6:55 PM

Building Forms with Conditional Fields

Official Documentation

Building Forms with Conditional Fields Forms can become dynamic forms where the answer to one question may allow the respondent to skip the next three questions, or require the respondent to answer...

Published Date: May 9, 2024 6:55 PM

Creating and Managing Forms

Official Documentation

Creating and Managing Forms The Forms application is in maintenance mode as of Liferay DXP 2024.Q4/Portal GA129. Migrate your forms to objects and form container fragments to future-proof your...

Published Date: May 9, 2024 6:55 PM

Forms Configuration Reference

Official Documentation

Forms Configuration Reference Here's an overview of all the Forms configurations so you can quickly find a configuration you need. Forms Options You can export and import forms between sites. To...

Published Date: Jan 18, 2025 2:49 AM

Creating Forms

Official Documentation

Creating Forms You can create multi-field forms with the Forms application. Only authenticated users with the requisite permissions can create forms. At minimum, they should have permission to...

Published Date: May 9, 2024 6:55 PM

Customizing Form Layouts

Official Documentation

Customizing Form Layouts By default, new elements on your form are added to a new row and occupy the entire width of the form. Form with all elements occupying entire width of form. Sometimes it...

Published Date: May 9, 2024 6:55 PM

Customizing Auto-Save Behavior

Official Documentation

Customizing Auto-Save Behavior The Forms application automatically saves the form creation progress as you create a form. By default, a form's draft is auto-saved every minute. To change the...

Published Date: May 9, 2024 6:55 PM

Forms Field Types Reference

Official Documentation

Forms Field Types Reference The Liferay Forms application contains lots of field types and elements to add to your forms. To discover the available elements, Open the Product Menu (Product Menu)...

Published Date: May 9, 2024 6:55 PM

Customizing the Submit Button

Official Documentation

Customizing the Submit Button Available 7.4+ When a User is finished entering data into a form, they must submit the form. By default a button that says Submit is displayed for this purpose. ...

Published Date: Jan 18, 2025 2:49 AM

Exporting and Importing Forms

Official Documentation

Exporting and Importing Forms You can export all your forms as a LAR file and then import them into a different Site for reuse. See Exporting/Importing Site Pages and Content to learn about the...

Published Date: May 9, 2024 6:55 PM

Field Autocompletion

Official Documentation

Field Autocompletion You can configure form field autocompletion in the Forms application: Autocompletion TypeConfigurationField Types ManualType a list of autocompletion optionsText Data...

Published Date: Jan 18, 2025 2:49 AM

Forms Permissions Reference

Official Documentation

Forms Permissions Reference This article serves as a guide for all permissions associated with the Forms application. Form Widget Permissions Navigate to the site page where the Form widget has...

Published Date: Jan 18, 2025 2:49 AM

Reusing Sets of Form Elements

Official Documentation

Reusing Sets of Form Elements Forms often request the same sets of information, such as name, birthday, and address. Rather than adding these fields for every new form, you can group elements as a...

Published Date: May 9, 2024 6:56 PM

Translating Forms

Official Documentation

Translating Forms Forms can be translated and presented in any language that is currently enabled on the current site. To add a translation: Begin by viewing an existing form (e.g., Guest...

Published Date: Jan 18, 2025 2:49 AM

Providing Help Text and Predefined Values

Official Documentation

Providing Help Text and Predefined Values Form fields can be configured to have help text, placeholder text, and predefined values that assist users in understanding and filling out a form. Help...

Published Date: Jan 18, 2025 2:49 AM

Using the REST Data Provider to Populate Form Options

Official Documentation

Using the REST Data Provider to Populate Form Options Select from List fields can hold many options. Those options can be supplied automatically by using the JSON web services registered in Liferay...

Published Date: May 9, 2024 6:56 PM

Validation and Masking

Official Documentation

Validation and Masking Certain Forms fields can be validated (Text, Date, and Numeric fields) and masked (Numeric fields) to ensure User input is valid. Date Fields can be validated beginning in...

Published Date: May 9, 2024 6:56 PM

Validation Conditions Reference

Official Documentation

Validation Conditions Reference There are several out-of-the-box validation conditions that can be used to validate form responses before they are submitted. Text Field Validation Conditions...

Published Date: May 9, 2024 6:56 PM

Using Storage Adapters

Official Documentation

Using Storage Adapters When a User adds a form record, Liferay routes the processing of the request through a storage adapter API. The same is true for the other CRUD operations performed on form...

Published Date: Jan 18, 2025 2:49 AM

Using the Search Location Field

Official Documentation

Using the Search Location Field Use a Search Location field so a user can interact with Google's Maps JavaScript API and Google Places API, selecting a location and getting these fields autofilled...

Published Date: May 9, 2024 6:56 PM