Search Results

All Results 7014
Sort By
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
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,...
User Account API Basics
Official Documentation
User Account API Basics You can add and manage users from the Control Panel, but you can also use Liferay's REST APIs. You can call these services to add, edit, delete users. Start with adding a...
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...
Regions API Basics
Official Documentation
Regions API Basics Liferay 7.4 U24+ and GA24+ Use Liferay's REST APIs to create and manage regions. Adding a Region Then, follow these steps: Download and unzip Regions API Basics. curl...
User Groups API Basics
Official Documentation
User Groups API Basics You can Create and Manage User Groups from the Application menu, but you can also use Liferay's REST APIs. Call these services to manage user groups. Adding a User Group ...
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...
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...
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,...
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...
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...
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,...
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...
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...
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: ...
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...
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)....
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...
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...
Client Secret JWT
Official Documentation
Client Secret JWT Liferay supports client secret JWT as an authentication method for OAuth 2 clients. In this flow, the client itself creates the assertion and signs it using the client secret....
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...
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...
Configuring the JWT Bearer Flow
Official Documentation
Configuring the JWT Bearer Flow The JWT Bearer flow trades a signed JWT from an external token service in exchange for an access token from Liferay. To use this flow, create an OAuth 2 client and...
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...
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...
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...
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...
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: ...
JAX-RS
JAX-RS JAX-RS web services work in Liferay modules the same way they work outside of Liferay, though you must register the class in the OSGi framework. To learn how to create these applications,...
App Builder
Official Documentation
App Builder Liferay CE/DXP 7.3 (deprecated and removed in 7.4) App Builder is a low-code application development solution for Liferay DXP. Build a data model, define the application's forms (for...
Low Code
Official Documentation
Low Code
Creating the Role Change Request App
Official Documentation
Creating the Role Change Request App Subscribers The Role Change Request App starts with the employee submitting a request form. Processing then proceeds to the Current Manager, then to the...
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...
Data Sets
Official Documentation
Data Sets Liferay DXP 2024.Q1+/Portal GA112+ Currently, this feature is behind a release feature flag (LPS-164563). Data sets collect data from Liferay headless APIs for you to manage and...
Creating a Standard Application
Official Documentation
Creating a Standard Application To create applications based on a custom object takes four steps: create the object, create at least one form view, create at least one table view, and deploy the...
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...
Creating the Role Change Request Object
Official Documentation
Creating the Role Change Request Object Subscribers Consider a Human Resources application that collects employee requests to change Roles within the software engineering department: the Role...
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...
Creating a Workflow Powered Application
Official Documentation
Creating a Workflow Powered Application Subscribers Workflow Powered Applications require data from multiple stakeholders. These process-driven applications can go through multiple stages before...
Managing Data Sets
Official Documentation
Managing Data Sets Liferay DXP 2024.Q1+/Portal GA112+ This feature is behind a release feature flag (LPS-164563). Once you create a data set, you can customize how users see it. Choose which...
Creating Data Sets
Official Documentation
Creating Data Sets Liferay DXP 2024.Q1+/Portal GA112+ Currently, this feature is behind a release feature flag (LPS-164563). You can create data sets from different resources available through...
Data Set Visualization Modes
Official Documentation
Data Set Visualization Modes Liferay DXP 2024.Q2+/Portal GA120+ Currently, this feature is behind a release feature flag (LPS-164563). To customize the data display in your data set, use the...
Data Set Filters
Official Documentation
Data Set Filters Liferay DXP 2024.Q1/Portal GA112 Currently, this feature is behind a release feature flag (LPS-164563). While managing data sets, you can define pre-applied filters to be used...
Viewing Data Sets
Official Documentation
Viewing Data Sets Liferay DXP 2024.Q1+/Portal GA112+ This feature is behind a release feature flag (LPS-164563). Once you create a data set, add it to a page to present it to your users. Users...
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...
Data Set Sorting
Official Documentation
Data Set Sorting Liferay DXP 2024.Q1/Portal GA112 Currently, this feature is behind a release feature flag (LPS-164563). While managing data sets, you can set default sorting rules for Data Sets...
Data Set Actions
Official Documentation
Data Set Actions Liferay DXP 2024.Q1+/Portal GA112+ Currently, this feature is behind a release feature flag (LPS-164563). While managing data set, define actions to be used in the data set...
Using Data Set Actions
Official Documentation
Using Data Set Actions Liferay DXP 2024.Q1/Portal GA112 Currently, this feature is behind a release feature flag (LPS-164563). Here are some examples for how to use data set actions and perform...
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...
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...
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. ...
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...
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...
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...
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...
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...
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)...
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...
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...
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...

Showing 8,161 to 8,220 of 8,808 entries.