Search Results

All Results 6974
Sort By
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
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: ...
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...
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,...
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. Fields Parameter Use this parameter to specify and...
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,...
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...
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...
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...
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...
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,...
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...
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...
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....
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...
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)....
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...
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...
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
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...
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: ...
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...
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...
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...
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...
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 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 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...
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 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...
Managing Data Sets
Official Documentation
Managing Data Sets Liferay DXP 2024.Q1+/Portal GA112+ Currently, this feature is behind a release feature flag (LPS-164563). Once you create a data set, you can customize how users see it....
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...
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...
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...
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...
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...
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...
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...
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...
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 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...
Using the Search Location Field
Official Documentation
Using the Search Location Field Use a Search Location field so a user can interact with Google's Maps JavaScript API and Google Places API, selecting a location and getting these fields autofilled...
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)...
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...
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...
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...
Providing Help Text and Predefined Values
Official Documentation
Providing Help Text and Predefined Values Form fields can be configured to have help text, placeholder text, and predefined values that assist users in understanding and filling out a form. Help...
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...
Validation and Masking
Official Documentation
Validation and Masking Certain Forms fields can be validated (Text, Date, and Numeric fields) and masked (Numeric fields) to ensure User input is valid. Date Fields can be validated beginning in...
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...
Forms Permissions Reference
Official Documentation
Forms Permissions Reference This article serves as a guide for all permissions associated with the Forms application. Form Widget Permissions Navigate to the site page where the Form widget has...
Translating Forms
Official Documentation
Translating Forms Forms can be translated and presented in any language that is currently enabled on the current site. To add a translation: Begin by viewing an existing form (e.g., Guest...
Using the REST Data Provider to Populate Form Options
Official Documentation
Using the REST Data Provider to Populate Form Options Select from List fields can hold many options. Those options can be supplied automatically by using the JSON web services registered in Liferay...
Data Providers
Official Documentation
Data Providers Data providers serve data that can be consumed by the Forms application. The REST Data Provider is included with the Forms application. With it, you can consume data from REST web...
Validation Conditions Reference
Official Documentation
Validation Conditions Reference There are several out-of-the-box validation conditions that can be used to validate form responses before they are submitted. Text Field Validation Conditions...
Writing a Custom Form Field Type
Official Documentation
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...