Site Search - Liferay Learn

Forms Analytics 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...

Configuring Mentions

Official Documentation

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

Managing Notifications and Requests

Official Documentation

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

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

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

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

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

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

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

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,...

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

Consuming GraphQL APIs

Official Documentation

Consuming GraphQL APIs Liferay DXP contains GraphQL APIs for most of its applications. The GraphQL APIs are available at http://[host]:[port]/o/graphql. Here's how to consume them in three steps: ...

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

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

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

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. Some endpoints do not make use of the filter, sort,...

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: ...

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,...

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

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

Authenticating with CAS (Central Authentication Service)

Official Documentation

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 instead. CAS is a widely used open source...

Configuring SAML at the System Level

Official Documentation

Configuring SAML at the System Level Subscription Before allowing any portal instances to enable SAML authentication, you should configure it at the system level so those instances have a...

Importing User Groups' Memberships from an External IdP through SAML

Official Documentation

Importing User Groups' Memberships from an External IdP through SAML Subscription This feature was released behind a dev feature flag. It was made Generally Available (GA) in Liferay DXP...

Configuring Sign-In

Official Documentation

Configuring Sign-In By default, Liferay DXP uses the Sign In widget to authenticate users. The Sign In widget appears on the default home page at http[s]://[server-name:port]/web/guest/home. If...

Configuring Single Sign-On

Official Documentation

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

Authenticating with Kerberos

Official Documentation

Authenticating with Kerberos You can use Kerberos to authenticate Microsoft Windows™ accounts with Liferay DXP, using Liferay DXP's LDAP support and a web server that supports the Kerberos...

Authenticating with SAML

Official Documentation

Authenticating with SAML Subscription 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...

Configuring SAML at the Instance Level

Official Documentation

Configuring SAML at the Instance Level Subscription Each portal instance can be a SAML provider, either an Identity Provider (IdP) or a Service Provider (SP). Whichever role your DXP instance...

SAML Authentication Process Overview

Official Documentation

SAML Authentication Process Overview Subscription 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...

Token-based Single Sign On Authentication

Official Documentation

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

SAML Admin

Official Documentation

SAML Admin Subscription 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. Starting...

Configuring Liferay Authentication With Auth0 Using OpenId Connect

Official Documentation

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

Configuring Liferay Authentication With Okta Using OpenId Connect

Official Documentation

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

Configuring Liferay Authentication With PingOne Using SAML

Official Documentation

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

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

Using OpenAM

Official Documentation

Using OpenAM Deprecated in Liferay DXP 2024.Q4/Portal GA129 OpenAM 13 is deprecated as of Liferay DXP 2024.Q4/Portal GA129. OpenAM 12 and below were deprecated as of Liferay DXP 7.2. Versions of...

Using OpenID Connect

Official Documentation

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

SCIM User API Basics

Official Documentation

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

Fast IDentity Online 2

Official Documentation

Fast IDentity Online 2 Subscription 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,...

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

Multi-Factor Authentication

Official Documentation

Multi-Factor Authentication Subscription Liferay DXP 7.3+ Multi-Factor Authentication (MFA) provides better security by requiring users to prove their identity in multiple ways, or factors. The...

AntiSamy

Official Documentation

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

Multi-Factor Authentication Checkers

Official Documentation

Multi-Factor Authentication Checkers Subscription Liferay DXP 7.4 ships with two additional factor checkers for Multi-Factor Authentication. Both of them are disabled by default, because they're...

Using Multi-Factor Authentication

Official Documentation

Using Multi-Factor Authentication Subscription To enhance your installation's security, you should disable less secure, one-factor forms of authentication, such as Basic Auth, Digest Auth, and...

Setting Up Liferay

Official Documentation

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) ...

Clustering for High Availability

Official Documentation

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

Configuring Cluster Link

Official Documentation

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

Configuring Unicast over TCP

Official Documentation

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

Configuring Mail

Official Documentation

Configuring Mail Liferay can be configured to use a mail server to send email notifications for a variety of purposes: user registration, password management, site membership notifications, content...

Database Configuration for Cluster Nodes

Official Documentation

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

Example: Creating a Simple DXP Cluster

Official Documentation

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

Configuring Microsoft Office 365 with OAuth

Official Documentation

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

Configuring Default Email Senders

Official Documentation

Configuring Default Email Senders By default, emails sent by Liferay DXP use the name and email address of the default admin user. This behavior can be configured for each of the different email...

Initial Instance Localization

Official Documentation

Initial Instance Localization Liferay DXP supports localization by language, time zone, and more. The English (US) language translation and UTC time zone are the defaults, but DXP has over 40...

Tuning Liferay

Official Documentation

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

Tuning Your JVM

Official Documentation

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

Serving Static Resources via a CDN

Official Documentation

Serving Static Resources via a CDN This article explains how to configure Liferay to rewrite URLs for static resources (images, CSS, JS) so they are served from a separate CDN domain. A Content...

Enabling Workflow for Objects

Official Documentation

Enabling Workflow for Objects Liferay 7.4+ Every published object is integrated automatically with the Workflow framework, so you can direct object entry creation through a defined review and...

Picklists

Official Documentation

Picklists Liferay 7.4+ Liferay picklists are predefined lists of string values that consist of a name/key pair and can include any number of items. Once a list is created, you can use it to add a...

Exporting and Importing Picklists

Official Documentation

Exporting and Importing Picklists You can transfer picklists between environments as JSON files using Liferay's export/import framework. Exporting Picklists Open the Global Menu (Global Menu),...

Search Results