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

Forms

Forms Forms are important direct data gathering tools for enterprises. Are your web forms providing you invaluable information or turning users away? Analytics Cloud gives you important insights. ...

Published Date: May 9, 2024 6:44 PM

Sending Emails

Sending Emails You can configure Liferay to send email notifications for different events that happen in your store. For example, you may want to send updates to the order manager or another person...

Published Date: Nov 22, 2024 10:47 PM

Notification Template Variables Reference Guide

Notification Template Variables Reference Guide When creating notification templates, you can use variables to populate email fields dynamically with data from the triggering event. Notification...

Published Date: Nov 22, 2024 10:47 PM

Configuring the Commerce Notification Queue

Configuring the Commerce Notification Queue When channel events trigger notifications, Commerce logs them in the channel's Notification Queue tab with the Unsent status. By default, Liferay checks...

Published Date: Nov 22, 2024 10:47 PM

Using Notification Templates

Using Notification Templates Email notifications are sent automatically to users based on events in the store. To send them, you must first create a Notification Template. Notification templates...

Published Date: Nov 22, 2024 10:47 PM

Configuring Mentions

Configuring Mentions Mentions are enabled by the Mentions app. By default, the Mentions app is enabled globally. However, this can be enabled or disabled either globally or per Site. Configuring...

Published Date: May 9, 2024 6:49 PM

Notifications and Requests

Published Date: Jan 18, 2025 2:46 AM

User Guide

User Guide Mentioning Users Managing Notifications and Requests Configuring Mentions

Published Date: May 9, 2024 6:49 PM

Managing Notifications and Requests

Managing Notifications and Requests Users receive notifications and requests if they have subscribed to a blog or message board or are mentioned in a post. They may also be notified if someone sent...

Published Date: May 9, 2024 6:49 PM

Mentioning Users

Mentioning Users Mentioning other users in a DXP asset draws their attention to a particular asset (for example, a message boards thread, blog post, or comment) by sending them a site and email...

Published Date: Jan 18, 2025 2:46 AM

Consuming GraphQL APIs

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

Configuring JSON Web Services

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

Consuming REST Services

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

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

Published Date: May 9, 2024 6:51 PM

Making Unauthenticated Requests

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

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

Sample API Tutorials

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 Liferay as a Headless Platform

Using Liferay as a Headless Platform Liferay provides a suite of APIs that perform the same kinds of actions available in the web interface. This is essential when you must get data in a...

Published Date: Nov 22, 2024 10:48 PM

Using OAuth 2.0

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

Authorizing Account Access with OAuth2

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

Getting Started

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

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

Consuming APIs

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 Headers Reference

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

API Query Parameters

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

Navigating DXP

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

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

Published Date: May 9, 2024 6:51 PM

Building a Sample API Application

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

Published Date: May 9, 2024 6:51 PM

APIs with REST Builder

APIs with 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...

Published Date: May 9, 2024 6:51 PM

Producing and Implementing APIs with REST Builder

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

Batch Engine API Basics - Exporting Data

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

Batch Engine API Basics - Importing Data

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

Creating an OAuth2 Application

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

JSON Web Tokens (JWTs)

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

Configuring the JWT Bearer Flow

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

OAuth 2 Scopes

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

Issuing JWT Access Tokens

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