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, 24, 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, 24, 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, 24, 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, 24, 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: May 9, 24, 6: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: May 9, 24, 6: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: May 9, 24, 6: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: May 9, 24, 6:47 PM

Notifications and Requests

Published Date: May 9, 24, 6:49 PM

User Guide

User Guide Mentioning Users Managing Notifications and Requests Configuring Mentions

Published Date: May 9, 24, 6:49 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, 24, 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, 24, 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: May 9, 24, 6:49 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, 24, 6:51 PM

What's New in Liferay DXP 7.3

What's New in Liferay DXP 7.3 The latest release of Liferay DXP includes many significant new features and improvements. These features will enhance how you build your site, analyze your site's...

Published Date: May 9, 24, 6:51 PM

What's New in Liferay DXP 7.4

What's New in Liferay DXP 7.4 Liferay DXP 7.4 comes with enhanced functionality and exciting improvements that make it even easier for both technical and non-technical users to deliver and optimize...

Published Date: May 9, 24, 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, 24, 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, 24, 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, 24, 6:51 PM

Building a Sample API Application

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

Published Date: May 9, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 6:51 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) This feature is currently behind a...

Published Date: May 9, 24, 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, 24, 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, 24, 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: May 9, 24, 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, 24, 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: May 9, 24, 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. Do this by accessing Control...

Published Date: May 9, 24, 6:51 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: May 9, 24, 6:51 PM

Using OAuth2 to Authorize Users

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: May 9, 24, 6:51 PM

DXP

DXP Welcome to the official documentation for the latest versions (7.3 and 7.4+) of Liferay DXP and Liferay Portal! Liferay DXP is the commercially supported and enterprise ready platform used...

Published Date: May 9, 24, 6:51 PM

Authentication Basics

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

Published Date: May 9, 24, 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, 24, 6:52 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 6:52 PM

Using OpenAM

Using OpenAM Liferay supports only OpenAM version 13. All other versions of OpenAM/OpenSSO are deprecated as of Liferay DXP 7.2. OpenAM is an open source single sign-on solution from the codebase...

Published Date: May 9, 24, 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, 24, 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, 24, 6:52 PM

Developer Guide

Published Date: May 9, 24, 6:52 PM

SCIM Group API Basics

SCIM Group API Basics Liferay DXP 2024.Q1+ [Beta Feature](../../../system-administration/configuring-liferay/feature-flags.md#beta-feature-flags) Liferay provides a headless API to perform CRUD...

Published Date: May 9, 24, 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, 24, 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, 24, 6:52 PM