Capability

Platform

Liferay DXP is a robust platform with its own navigation menus, configuration methods, and core features. These core features are foundational to effective system administration, maintenance, notifications, and other core platform functions.

Feature
Deployment Approach
Capability
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
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
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
Using OAuth 2.0
Using OAuth 2.0 OAuth 2.0 is an industry-standard authorization protocol. Users can seamlessly share select credentials from your Liferay-based website with various clients. OAuth 2.0 works by...
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
Authenticating with CAS (Central Authentication Service)
Authenticating with CAS (Central Authentication Service) CAS was deprecated as of Liferay DXP 7.2 and removed as of Liferay DXP 7.4. Please use [SAML](./authenticating-with-saml.md) instead. CAS...
Published Date: May 9, 2024 6:52 PM
Configuring SAML at the System Level
Configuring SAML at the System Level Before allowing any portal instances to enable SAML authentication, you should configure it at the system level so those instances have a foundation from which...
Published Date: May 9, 2024 6:52 PM
Importing User Groups' Memberships from an External IdP through SAML
Importing User Groups' Memberships from an External IdP through SAML This feature was released behind a dev feature flag. It was made Generally Available (GA) in Liferay DXP 2024.Q2/GA120. You...
Published Date: May 9, 2024 6:52 PM
Configuring Single Sign-On
Configuring Single Sign-On Liferay Portal/DXP supports many ways of authenticating, from token-based solutions to standards such as OpenID Connect and SAML. With all the available options, you...
Published Date: May 9, 2024 6:52 PM
Authenticating with Kerberos
Authenticating with Kerberos You can use Kerberos to authenticate Microsoft Windows™ accounts with Liferay DXP. This is done by using a combination of Liferay DXP's LDAP support and a web server...
Published Date: May 9, 2024 6:52 PM
Authenticating with SAML
Authenticating with SAML The SAML (Security Assertion Markup Language) adapter provides Single Sign On (SSO) and Single Log Off (SLO) in your deployment. SAML works by using Identity Providers...
Published Date: May 9, 2024 6:52 PM
Configuring SAML at the Instance Level
Configuring SAML at the Instance Level Each portal instance can be a SAML provider, either an Identity Provider (IdP) or a Service Provider (SP). Whichever role your DXP instance fills, you can...
Published Date: May 9, 2024 6:52 PM
SAML Authentication Process Overview
SAML Authentication Process Overview Both the IdP and the SP can initiate the Single Sign On process, and the SSO flow is different depending on each one. Regardless of how it's initiated, SSO is...
Published Date: May 9, 2024 6:52 PM
SAML Settings
SAML Settings Many of the same fields appear in both the Service Provider and the Identity Provider configurations. Here's a reference. Name: Name the SP or IdP. This is just a descriptive name;...
Published Date: May 9, 2024 6:52 PM
Token-based Single Sign On Authentication
Token-based Single Sign On Authentication Token-based SSO authentication was introduced in Liferay Portal 7.0 to standardize support for Shibboleth, SiteMinder, Oracle OAM, and any SSO product that...
Published Date: May 9, 2024 6:52 PM
SAML Admin
SAML Admin The SAML Admin panel is the best place to configure your SAML instance. Use it instead of Instance Settings to streamline your SAML administration experience. You can configure an...
Published Date: May 9, 2024 6:52 PM
Configuring Liferay Authentication With Auth0 Using OpenId Connect
Configuring Liferay Authentication With Auth0 Using OpenId Connect This tutorial guides you through integrating Auth0, your Identity Provider (IdP), with your Liferay environment using OpenID...
Published Date: May 9, 2024 6:52 PM
Configuring Liferay Authentication With Okta Using OpenId Connect
Configuring Liferay Authentication With Okta Using OpenId Connect This tutorial guides you through the basic steps needed to integrate Okta, your Identity Provider (IdP), with your environment...
Published Date: May 9, 2024 6:52 PM
Configuring Liferay Authentication With PingOne Using SAML
Configuring Liferay Authentication With PingOne Using SAML This tutorial guides you through the basic steps needed to integrate PingOne, your Identity Provider (IdP), with your Liferay environment...
Published Date: May 9, 2024 6:52 PM
Using OpenAM
Using OpenAM Deprecated in Liferay DXP 2024.Q4/GA129 OpenAM 13 is deprecated as of Liferay DXP 2024.Q4/GA129. OpenAM 12 and below were deprecated as of Liferay DXP 7.2. Versions of...
Published Date: May 9, 2024 6:52 PM
Using OpenID Connect
Using OpenID Connect OpenID Connect is a lightweight authentication layer that enables users to authenticate using accounts they have on other systems. It's built on top of the OAuth 2.0...
Published Date: May 9, 2024 6:52 PM
Developer Guide
Developer Guide
Published Date: May 9, 2024 6:52 PM
Fast IDentity Online 2
Fast IDentity Online 2 Available: Liferay DXP/Portal 7.4+ The Fast IDentity Online 2 or FIDO2 standard allows for the use of biometrics (i.e., fingerprint readers), mobile devices, or other...
Published Date: May 9, 2024 6:52 PM
Multi-Factor Authentication
Multi-Factor Authentication Liferay DXP 7.3+ Multi-Factor Authentication (MFA) provides better security by requiring users to prove their identity in multiple ways, or factors. The basic user...
Published Date: May 9, 2024 6:52 PM
AntiSamy
AntiSamy Liferay DXP includes an AntiSamy module that protects against user-entered malicious code. If your site allows users to post content in message boards, blogs, or other applications, these...
Published Date: May 9, 2024 6:52 PM
Multi-Factor Authentication Checkers
Multi-Factor Authentication Checkers Liferay DXP 7.4 ships with two additional factor checkers for Multi-Factor Authentication. Both of them are disabled by default, because they're only useful in...
Published Date: May 9, 2024 6:52 PM
Using Multi-Factor Authentication
Using Multi-Factor Authentication To enhance your installation's security, you should disable less secure, one-factor forms of authentication, such as Basic Auth, Digest Auth, and WebDAV. You can...
Published Date: May 9, 2024 6:52 PM
Clustering for High Availability
Clustering for High Availability Liferay DXP can scale to serve everything from the smallest to the largest web sites. Out-of-the-box, it's configured optimally for a single server environment. If...
Published Date: May 9, 2024 6:52 PM
Configuring Cluster Link
Configuring Cluster Link Enabling Cluster Link activates distributed caching. The cache is distributed across multiple Liferay DXP nodes running concurrently. Cluster Link uses Ehcache replication....
Published Date: May 9, 2024 6:52 PM
Configuring Unicast over TCP
Configuring Unicast over TCP If your network configuration or the geographical distance between cluster nodes prevents you from using UDP Multicast clustering, you can configure TCP Unicast. You...
Published Date: May 9, 2024 6:52 PM
Configuring Mail
Configuring Mail Liferay DXP/Portal can be configured to use a mail server to send email notifications for a variety of purposes: User registration and password management, Site membership...
Published Date: May 9, 2024 6:52 PM
Database Configuration for Cluster Nodes
Database Configuration for Cluster Nodes At minimum, nodes in a DXP cluster must be configured to share the same database (or database cluster) in order to function. Optimizations discussed here...
Published Date: May 9, 2024 6:52 PM
Example: Creating a Simple DXP Cluster
Example: Creating a Simple DXP Cluster A fast, easy way to learn DXP clustering is to set up a two node DXP cluster environment on one machine using Docker containers. This example creates two DXP...
Published Date: May 9, 2024 6:52 PM
Alternative Email Configuration Methods
Alternative Email Configuration Methods There are several methods of configuring Liferay DXP to connect to a mail server. The simplest way to get started is to configure mail using through the...
Published Date: May 9, 2024 6:52 PM
Configuring Microsoft Office 365 with OAuth
Configuring Microsoft Office 365 with OAuth Liferay DXP 7.4 U79+/Liferay Portal 7.4 GA79+ Connect your Microsoft email service to Liferay with the use of OAuth 2.0 authorization. Note, Microsoft...
Published Date: May 9, 2024 6:52 PM
Configuring Default Email Senders
Configuring Default Email Senders By default, emails sent by Liferay DXP use the name and email address as the default admin user. This behavior can be configured for each of the different email...
Published Date: May 9, 2024 6:52 PM
Initial Instance Localization
Initial Instance Localization Liferay DXP supports localization by language, time zone, and more. The English (US) language translation and GMT time zone are the defaults, but DXP has over 40...
Published Date: May 9, 2024 6:52 PM
Tuning Liferay
Tuning Liferay There are several ways to tune Liferay's performance. This involves configuring the Java Virtual Machine and frameworks that support the Liferay application, monitoring performance...
Published Date: May 9, 2024 6:52 PM
Tuning Your JVM
Tuning Your JVM Java Virtual Machine (JVM) tuning primarily focuses on adjusting Java heap and non-heap settings and configuring garbage collection. Finding settings that perform well for you...
Published Date: May 9, 2024 6:52 PM
Using a CDN
Using a CDN A Content Delivery Network (CDN) is a distributed infrastructure for caching static, file-based content. When visitors hit your site, your static content is loaded from the server...
Published Date: May 9, 2024 6:52 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
Setting Up Liferay
Setting Up Liferay After installing Liferay, configure it to meet your needs. Here are common setup tasks. Setup Tasks Preconfigure the System Activate Liferay (Subscription Required) ...
Published Date: May 9, 2024 6:52 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
Notifications API Basics
Notifications API Basics Liferay's headless delivery application provides REST and GraphQL services for subscribing to or unsubscribing from notifications for platform events across several default...
Published Date: Oct 4, 2024 4:10 PM
SCIM Group API Basics
SCIM Group API Basics Liferay DXP 2024.Q1+ Liferay provides a headless API to perform CRUD operations on SCIM groups to keep their information in sync with your company's applications. SCIM groups...
Published Date: May 9, 2024 6:52 PM
Provisioning Cloud Apps
Provisioning Cloud Apps You can provision cloud apps to your Liferay instance and start using them immediately. Unlike DXP apps that require manual download and deployment, cloud apps integrate...
Published Date: Feb 11, 2025 12:35 PM
Provisioning DXP Apps
Provisioning DXP Apps Free apps can be downloaded, deployed to Liferay DXP, and used immediately without deploying a license. Paid apps have trial, developer, or standard licenses based on the...
Published Date: Nov 8, 2024 3:11 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
SCIM User API Basics
SCIM User API Basics Liferay DXP 2024.Q1+ Liferay provides a headless API to perform CRUD operations on SCIM users to keep their identity information in sync with your company's applications. Use...
Published Date: May 9, 2024 6:52 PM
Captcha API Basics
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
Writing a Custom Form Field Type
Writing a Custom Form Field Type The Forms application contains many highly configurable field types out-of-the-box. Most use cases are met with one of the existing field types. If your use case...
Published Date: May 9, 2024 6:56 PM
Creating a Condition Evaluator
Creating a Condition Evaluator A Workflow condition node uses a Groovy script to determine the proper transition a workflow item traverses. Instead of writing logic in Groovy directly in a workflow...
Published Date: May 9, 2024 6:56 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
Data Migration Center
Data Migration Center Liferay DXP 2023.Q4+/Portal 7.4 GA102+ [Beta Feature](../../system-administration/configuring-liferay/feature-flags.md#beta-feature-flags) Currently, this feature is behind...
Published Date: May 9, 2024 6:51 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
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
API Builder
API Builder Liferay DXP 2023.Q4+/Portal 7.4 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
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

Capabilities

Product

Education

Contact Us

Connect

Powered by Liferay
© 2024 Liferay Inc. All Rights Reserved • Privacy Policy