Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/liferay-client-extension-yaml/_shared/latest--client-extension-type-instance-settings.schema.json
Parent schema liferay-client-extension-yaml
Type: object

Properties

pid enum
Values: "com.liferay.account.configuration.AccountEntryEmailConfiguration" "com.liferay.account.configuration.AccountEntryEmailDomainsConfiguration" "com.liferay.adaptive.media.image.content.transformer.backwards.compatibility.internal.configuration.AMBackwardsCompatibilityHtmlContentTransformerConfiguration" "com.liferay.adaptive.media.image.internal.configuration.AMImageCompanyConfiguration" "com.liferay.ai.creator.openai.configuration.AICreatorOpenAICompanyConfiguration" "com.liferay.ai.hub.cell.configuration.AIHubCellConfiguration" "com.liferay.analytics.settings.configuration.AnalyticsConfiguration" "com.liferay.asset.auto.tagger.google.cloud.natural.language.internal.configuration.GCloudNaturalLanguageAssetAutoTaggerCompanyConfiguration" "com.liferay.asset.auto.tagger.internal.configuration.AssetAutoTaggerCompanyConfiguration" "com.liferay.asset.auto.tagger.opennlp.internal.configuration.OpenNLPDocumentAssetAutoTaggerCompanyConfiguration" "com.liferay.asset.categories.configuration.AssetCategoriesCompanyConfiguration" "com.liferay.batch.engine.configuration.BatchEngineTaskCompanyConfiguration" "com.liferay.captcha.configuration.CaptchaConfiguration" "com.liferay.captcha.internal.configuration.FunctionCaptchaImplConfiguration" "com.liferay.change.tracking.configuration.CTCollectionEmailConfiguration" "com.liferay.change.tracking.configuration.CTSettingsConfiguration" "com.liferay.change.tracking.web.internal.configuration.CTConfiguration" "com.liferay.click.to.chat.web.internal.configuration.ClickToChatConfiguration" "com.liferay.client.extension.type.configuration.CETConfiguration" "com.liferay.commerce.payment.configuration.CommercePaymentEntryAuditConfiguration" "com.liferay.commerce.payment.configuration.CommercePaymentEntryRefundTypeConfiguration" "com.liferay.commerce.product.configuration.CPConfigurationListRelConfiguration" "com.liferay.commerce.product.configuration.CPDefinitionOptionRelConfiguration" "com.liferay.commerce.product.configuration.CPFriendlyURLConfiguration" "com.liferay.commerce.product.configuration.CProductVersionConfiguration" "com.liferay.commerce.qualifier.configuration.AccountEntryCommerceQualifierConfiguration" "com.liferay.commerce.qualifier.configuration.AccountGroupCommerceQualifierConfiguration" "com.liferay.commerce.qualifier.configuration.AddressCommerceQualifierConfiguration" "com.liferay.commerce.qualifier.configuration.COREntryCommerceQualifierConfiguration" "com.liferay.commerce.qualifier.configuration.CommerceChannelCommerceQualifierConfiguration" "com.liferay.commerce.qualifier.configuration.CommerceCurrencyCommerceQualifierConfiguration" "com.liferay.commerce.qualifier.configuration.CommerceDiscountCommerceQualifierConfiguration" "com.liferay.commerce.qualifier.configuration.CommerceInventoryWarehouseCommerceQualifierConfiguration" "com.liferay.commerce.qualifier.configuration.CommerceOrderTypeCommerceQualifierConfiguration" "com.liferay.commerce.qualifier.configuration.CommercePaymentMethodGroupRelCommerceQualifierConfiguration" "com.liferay.commerce.qualifier.configuration.CommercePriceListCommerceQualifierConfiguration" "com.liferay.commerce.qualifier.configuration.CommerceShippingFixedOptionCommerceQualifierConfiguration" "com.liferay.commerce.qualifier.configuration.CommerceTermEntryCommerceQualifierConfiguration" "com.liferay.digital.signature.configuration.DigitalSignatureConfiguration" "com.liferay.document.library.asset.auto.tagger.google.cloud.vision.internal.configuration.GCloudVisionAssetAutoTagProviderCompanyConfiguration" "com.liferay.document.library.asset.auto.tagger.microsoft.cognitive.services.internal.configuration.MSCognitiveServicesAssetAutoTagProviderCompanyConfiguration" "com.liferay.document.library.asset.auto.tagger.tensorflow.internal.configuration.TensorFlowImageAssetAutoTagProviderCompanyConfiguration" "com.liferay.document.library.configuration.DLFileEntryFriendlyURLConfiguration" "com.liferay.document.library.configuration.DLFileEntryMimeTypeConfiguration" "com.liferay.document.library.google.drive.configuration.DLGoogleDriveCompanyConfiguration" "com.liferay.document.library.internal.configuration.DLIndexerConfiguration" "com.liferay.document.library.opener.onedrive.web.internal.configuration.DLOneDriveCompanyConfiguration" "com.liferay.document.library.web.internal.configuration.CacheControlConfiguration" "com.liferay.exportimport.configuration.ExportImportServiceConfiguration" "com.liferay.flags.configuration.FlagsGroupServiceConfiguration" "com.liferay.fragment.configuration.FragmentJavaScriptConfiguration" "com.liferay.fragment.configuration.FragmentServiceConfiguration" "com.liferay.fragment.entry.processor.freemarker.internal.configuration.FreeMarkerFragmentEntryProcessorConfiguration" "com.liferay.fragment.web.internal.configuration.FragmentPortletConfiguration" "com.liferay.friendly.url.configuration.FriendlyURLRedirectionConfiguration" "com.liferay.friendly.url.configuration.FriendlyURLSeparatorCompanyConfiguration" "com.liferay.frontend.js.spa.web.internal.configuration.SPAConfiguration" "com.liferay.frontend.js.web.internal.configuration.CustomDialogsSettingsConfiguration" "com.liferay.frontend.js.web.internal.configuration.FrontendCachingConfiguration" "com.liferay.frontend.js.web.internal.configuration.LiferayGlobalObjectConfiguration" "com.liferay.journal.configuration.JournalServiceConfiguration" "com.liferay.layout.content.page.editor.web.internal.configuration.PageEditorConfiguration" "com.liferay.layout.locked.layouts.web.internal.configuration.LockedLayoutsCompanyConfiguration" "com.liferay.layout.reports.web.internal.configuration.LayoutReportsGooglePageSpeedCompanyConfiguration" "com.liferay.layout.seo.internal.configuration.LayoutSEOCompanyConfiguration" "com.liferay.layout.set.prototype.configuration.LayoutSetPrototypeConfiguration" "com.liferay.mail.outlook.auth.connector.provider.internal.configuration.MailOutlookAuthConnectorCompanyConfiguration" "com.liferay.mail.settings.configuration.MailSettingCompanyConfiguration" "com.liferay.multi.factor.authentication.email.otp.configuration.MFAEmailOTPConfiguration" "com.liferay.multi.factor.authentication.fido2.web.internal.configuration.MFAFIDO2Configuration" "com.liferay.multi.factor.authentication.ip.address.internal.configuration.MFAIPAddressConfiguration" "com.liferay.multi.factor.authentication.sample.internal.configuration.MFASampleConfiguration" "com.liferay.multi.factor.authentication.timebased.otp.web.internal.configuration.MFATimeBasedOTPConfiguration" "com.liferay.oauth2.provider.rest.internal.configuration.OAuth2InAssertionConfiguration" "com.liferay.oauth2.provider.rest.internal.endpoint.authorize.configuration.AuthorizeScreenConfiguration" "com.liferay.object.configuration.ObjectConfiguration" "com.liferay.object.configuration.ObjectEntryScheduleConfiguration" "com.liferay.object.configuration.ObjectEntryVersionConfiguration" "com.liferay.osb.patcher.configuration.PatcherConfiguration" "com.liferay.osb.patcher.configuration.PatcherEmailConfiguration" "com.liferay.portal.crypto.hash.provider.bcrypt.internal.configuration.BCryptCryptoHashProviderConfiguration" "com.liferay.portal.crypto.hash.provider.message.digest.internal.configuration.MessageDigestCryptoHashProviderConfiguration" "com.liferay.portal.defaultpermissions.configuration.PortalDefaultPermissionsCompanyConfiguration" "com.liferay.portal.remote.cors.configuration.PortalCORSConfiguration" "com.liferay.portal.search.configuration.SemanticSearchConfiguration" "com.liferay.portal.search.elasticsearch8.configuration.DeepPaginationConfiguration" "com.liferay.portal.search.internal.configuration.SiteActivityAsahConfiguration" "com.liferay.portal.search.internal.configuration.UserActivityAsahConfiguration" "com.liferay.portal.search.opensearch2.configuration.DeepPaginationConfiguration" "com.liferay.portal.search.rest.configuration.SearchSuggestionsCompanyConfiguration" "com.liferay.portal.security.auto.login.internal.basic.auth.header.configuration.BasicAuthHeaderAutoLoginConfiguration" "com.liferay.portal.security.configuration.BasicAuthHeaderSupportConfiguration" "com.liferay.portal.security.iframe.sanitizer.configuration.IFrameConfiguration" "com.liferay.portal.security.ldap.authenticator.configuration.LDAPAuthConfiguration" "com.liferay.portal.security.ldap.configuration.LDAPServerConfiguration" "com.liferay.portal.security.ldap.configuration.SystemLDAPConfiguration" "com.liferay.portal.security.ldap.exportimport.configuration.LDAPExportConfiguration" "com.liferay.portal.security.ldap.exportimport.configuration.LDAPImportConfiguration" "com.liferay.portal.security.sso.openid.connect.internal.configuration.OpenIdConnectProviderConfiguration" "com.liferay.portal.vulcan.internal.configuration.HeadlessAPICompanyConfiguration" "com.liferay.portal.vulcan.internal.configuration.VulcanCompanyConfiguration" "com.liferay.product.navigation.personal.menu.configuration.PersonalMenuConfiguration" "com.liferay.redirect.internal.configuration.RedirectURLConfiguration" "com.liferay.saml.runtime.configuration.SamlProviderConfiguration" "com.liferay.search.experiences.internal.configuration.IpstackConfiguration" "com.liferay.search.experiences.internal.configuration.OpenWeatherMapConfiguration" "com.liferay.segments.asah.connector.internal.configuration.SegmentsAsahCompanyConfiguration" "com.liferay.segments.configuration.SegmentsCompanyConfiguration" "com.liferay.segments.context.vocabulary.internal.configuration.SegmentsContextVocabularyCompanyConfiguration" "com.liferay.sharepoint.rest.repository.internal.configuration.SharepointRepositoryConfiguration" "com.liferay.sharing.internal.configuration.SharingCompanyConfiguration" "com.liferay.site.cms.site.initializer.configuration.BulkActionTaskConfiguration" "com.liferay.site.internal.configuration.SitemapCompanyConfiguration" "com.liferay.social.activity.internal.configuration.SocialActivityCompanyConfiguration" "com.liferay.staging.configuration.StagingConfiguration" "com.liferay.translation.translator.aws.internal.configuration.AWSTranslatorConfiguration" "com.liferay.translation.translator.azure.internal.configuration.AzureTranslatorConfiguration" "com.liferay.translation.translator.deepl.internal.configuration.DeepLTranslatorConfiguration" "com.liferay.translation.translator.google.cloud.internal.configuration.GoogleCloudTranslatorConfiguration" "com.liferay.user.associated.data.web.internal.configuration.AnonymousUserConfiguration" "com.liferay.users.admin.configuration.UserFileUploadsConfiguration"

One of

1. Account Email object
pid const: "com.liferay.account.configuration.AccountEntryEmailConfiguration" required
Constant: "com.liferay.account.configuration.AccountEntryEmailConfiguration"
invitationEmailBody object

Provide a localized template for the body of user invitation emails.

invitationEmailSenderEmailAddress string

Define a specific email address for the sender of user invitation emails. If empty, the inviter's email address is used.

invitationEmailSenderName string

Define a specific name for the sender of user invitation emails. If empty, the inviter's name is used.

invitationEmailSubject object

Provide a localized template for the subject of user invitation emails.

invitationTokenExpirationTime number

Define the time (in hours) before the invitation token expires.

Default: 48
2. Email Domains object
pid const: "com.liferay.account.configuration.AccountEntryEmailDomainsConfiguration" required
Constant: "com.liferay.account.configuration.AccountEntryEmailDomainsConfiguration"
blockedEmailDomains string

Enter the list of account user email domains that are prohibited from self registration (e.g. gmail.com, yahoo.com, acme.com). Administrators can manually add account users with blocked email domains. Enter one email domain per line.

customTLDs string[]

Set custom top-level domains that will be used when validating an account's domains. These should not be common.

enableEmailDomainValidation boolean

Enable to allow entering a list of valid email domains when editing an account. Account users must have a matching email domain for self registration. Administrators can manually add account users with non-matching email domains.

Default: false
3. Backwards Compatibility HTML Content Transformer object
pid const: "com.liferay.adaptive.media.image.content.transformer.backwards.compatibility.internal.configuration.AMBackwardsCompatibilityHtmlContentTransformerConfiguration" required
Constant: "com.liferay.adaptive.media.image.content.transformer.backwards.compatibility.internal.configuration.AMBackwardsCompatibilityHtmlContentTransformerConfiguration"
enabled boolean

Enable postprocessing of all legacy markup in fragments, web content, and blogs so that Adaptive Media is able to work with it. Enabling this option may impact the performance of your sites.

Default: false
4. Variants object
pid const: "com.liferay.adaptive.media.image.internal.configuration.AMImageCompanyConfiguration" required
Constant: "com.liferay.adaptive.media.image.internal.configuration.AMImageCompanyConfiguration"
imageVariants string[]
5. OpenAI object
pid const: "com.liferay.ai.creator.openai.configuration.AICreatorOpenAICompanyConfiguration" required
Constant: "com.liferay.ai.creator.openai.configuration.AICreatorOpenAICompanyConfiguration"
apiKey string
Default: ""
enableChatGPTToCreateContent boolean
Default: true
enableDALLEToCreateImages boolean
Default: true
6. AI Hub Configuration object
clientId string required
clientSecret string required
pid const: "com.liferay.ai.hub.cell.configuration.AIHubCellConfiguration" required
Constant: "com.liferay.ai.hub.cell.configuration.AIHubCellConfiguration"
serviceURL string required
7. object object
pid const: "com.liferay.analytics.settings.configuration.AnalyticsConfiguration" required
Constant: "com.liferay.analytics.settings.configuration.AnalyticsConfiguration"
commerceSyncEnabledAnalyticsChannelIds string[]
contentRecommenderMostPopularItemsEnabled boolean
contentRecommenderUserPersonalizationEnabled boolean
firstSync boolean
Default: true
hostsAllowed string
liferayAnalyticsConnectionType string
liferayAnalyticsCredentialType string
liferayAnalyticsDataSourceId string
liferayAnalyticsEnableAllGroupIds boolean
liferayAnalyticsEndpointURL string
liferayAnalyticsFaroBackendSecuritySignature string
liferayAnalyticsFaroBackendURL string
liferayAnalyticsGroupIds string[]
liferayAnalyticsProjectId string
liferayAnalyticsURL string
previousCommerceSyncEnabledAnalyticsChannelIds string[]
previousContentRecommenderMostPopularItemsEnabled boolean
previousContentRecommenderUserPersonalizationEnabled boolean
previousSyncAllAccounts boolean
previousSyncAllContacts boolean
previousSyncedAccountFieldNames string[]
previousSyncedAccountGroupIds string[]
previousSyncedCommerceChannelIds string[]
previousSyncedContactFieldNames string[]
previousSyncedOrderFieldNames string[]
previousSyncedOrganizationIds string[]
previousSyncedProductFieldNames string[]
previousSyncedUserFieldNames string[]
previousSyncedUserGroupIds string[]
publicKey string
siteReportingGrouping string
syncAllAccounts boolean
syncAllContacts boolean
syncedAccountFieldNames string[]
syncedAccountGroupIds string[]
syncedCategoryFieldNames string[]
syncedCommerceChannelIds string[]
syncedContactFieldNames string[]
syncedGroupIds string[]
syncedOrderFieldNames string[]
syncedOrderItemFieldNames string[]
syncedOrganizationIds string[]
syncedProductChannelFieldNames string[]
syncedProductFieldNames string[]
syncedUserFieldNames string[]
syncedUserGroupIds string[]
token string
wizardMode boolean
Default: true
8. Google Cloud Natural Language Text Auto Tagging object

Auto tag of text using the Cloud Natural Language API.

apiKey string required

Set the API key for the Google Cloud Natural Language API. Billing must be enabled for this API to work. See {0} for more information.

pid const: "com.liferay.asset.auto.tagger.google.cloud.natural.language.internal.configuration.GCloudNaturalLanguageAssetAutoTaggerCompanyConfiguration" required

Auto tag of text using the Cloud Natural Language API.

Constant: "com.liferay.asset.auto.tagger.google.cloud.natural.language.internal.configuration.GCloudNaturalLanguageAssetAutoTaggerCompanyConfiguration"
classificationEndpointEnabled boolean

Enable auto tagging of text using the Cloud Natural Language API Classification endpoint.

confidence number

Set the classifier's confidence of the category. This number represents how certain the classifier is that this category represents the given text.

Default: 0.5
enabledClassNames string[]
Default: ""
entityEndpointEnabled boolean

Enable auto tagging of text using the Cloud Natural Language API Entity endpoint.

salience number

The salience score for an entity provides information about the importance or centrality of that entity to the entire text.

Default: 0.02
9. Asset Auto Tagging object
pid const: "com.liferay.asset.auto.tagger.internal.configuration.AssetAutoTaggerCompanyConfiguration" required
Constant: "com.liferay.asset.auto.tagger.internal.configuration.AssetAutoTaggerCompanyConfiguration"
enabled boolean
Default: true
maximumNumberOfTagsPerAsset number

Set the maximum number of tags that will be automatically added to a single asset. Set to 0 if there is no limit. The value defined for the system scope takes precedence over the one defined here, so If this value is greater than the one defined at system scope level, the threshold applied will be the one defined at system scope level.

updateAutoTags boolean

If this option is checked, the option to trigger auto tagging when editing an asset will be enabled by default.

Default: false
10. OpenNLP Text Auto Tagging object

OpenNLP Text Auto Tagging is based on three open source models (Location name finder model, Organization finder model, and Person name finder model). Use with caution because its accuracy may be limited.

pid const: "com.liferay.asset.auto.tagger.opennlp.internal.configuration.OpenNLPDocumentAssetAutoTaggerCompanyConfiguration" required

OpenNLP Text Auto Tagging is based on three open source models (Location name finder model, Organization finder model, and Person name finder model). Use with caution because its accuracy may be limited.

Constant: "com.liferay.asset.auto.tagger.opennlp.internal.configuration.OpenNLPDocumentAssetAutoTaggerCompanyConfiguration"
confidenceThreshold number

Set the minimum confidence threshold (from 0 to 1) above which tags will be applied.

Default: 0.1
enabledClassNames string[]
Default: ""
11. Categorization object
pid const: "com.liferay.asset.categories.configuration.AssetCategoriesCompanyConfiguration" required
Constant: "com.liferay.asset.categories.configuration.AssetCategoriesCompanyConfiguration"
includeChildrenCategoriesWhenSearchingParentCategories boolean

When checked, assets with child categories also appear in search results. When unchecked, only assets with the exact category matches appear in search results.

Default: true
maximumNumberOfCategoriesPerVocabulary number

Specify the maximum number of categories that a vocabulary can have.

Default: 150
12. Batch Engine Task Configuration object
pid const: "com.liferay.batch.engine.configuration.BatchEngineTaskCompanyConfiguration" required
Constant: "com.liferay.batch.engine.configuration.BatchEngineTaskCompanyConfiguration"
csvFileColumnDelimiter string
Default: ","
exportBatchSize number

Set the default size of a batch containing records to be written to an export file.

Default: 100
importBatchSize number

Set the default size of a batch containing records from an import file that will be written to a database.

Default: 100
13. CAPTCHA object
pid const: "com.liferay.captcha.configuration.CaptchaConfiguration" required
Constant: "com.liferay.captcha.configuration.CaptchaConfiguration"
captchaEngine string

Set the engine used to generate captchas. reCAPTCHA uses an external service that must be configured independently but provides an audible alternative which makes the captcha accessible to the visually impaired. See https://www.google.com/recaptcha/admin/create for details.

Default: "com.liferay.captcha.simplecaptcha.SimpleCaptchaImpl"
createAccountCaptchaEnabled boolean
Default: true
maxChallenges number

Set the maximum number of captcha checks per portlet session. Set this value to 0 to always check. Set this value to a number less than 0 to never check. Unauthenticated users will always be checked on every request if captcha checks are enabled.

Default: 1
messageBoardsEditCategoryCaptchaEnabled boolean
Default: false
messageBoardsEditMessageCaptchaEnabled boolean
Default: false
reCaptchaNoScriptURL string
Default: "https://www.google.com/recaptcha/api/fallback?k="
reCaptchaPrivateKey string
reCaptchaPublicKey string
reCaptchaScriptURL string
Default: "https://www.google.com/recaptcha/api.js"
reCaptchaVerifyURL string
Default: "https://www.google.com/recaptcha/api/siteverify"
sendPasswordCaptchaEnabled boolean
Default: true
simpleCaptchaBackgroundProducers string[]

Input class names that implement nl.captcha.backgrounds.BackgroundProducer. These classes will be randomly used by Simple CAPTCHA to generate a background for a captcha image.

Default: "nl.captcha.backgrounds.FlatColorBackgroundProducer|nl.captcha.backgrounds.GradiatedBackgroundProducer|nl.captcha.backgrounds.SquigglesBackgroundProducer|nl.captcha.backgrounds.TransparentBackgroundProducer"
simpleCaptchaGimpyRenderers string[]

Input class names that implement nl.captcha.gimpy.GimpyRenderer. These classes will be randomly used by Simple CAPTCHA to gimp a captcha image.

Default: "com.liferay.captcha.simplecaptcha.gimpy.BlockGimpyRenderer|com.liferay.captcha.simplecaptcha.gimpy.DropShadowGimpyRenderer|nl.captcha.gimpy.FishEyeGimpyRenderer|com.liferay.captcha.simplecaptcha.gimpy.RippleGimpyRenderer|nl.captcha.gimpy.ShearGimpyRenderer"
simpleCaptchaHeight number

Set the height for captcha images generated by Simple CAPTCHA.

Default: 50
simpleCaptchaNoiseProducers string[]

Input class names that implement nl.captcha.noise.NoiseProducer. These classes will be randomly used by Simple CAPTCHA to add noise to a captcha image.

Default: "nl.captcha.noise.CurvedLineNoiseProducer|nl.captcha.noise.StraightLineNoiseProducer"
simpleCaptchaTextProducers string[]

Input class names that implement nl.captcha.text.producer.TextProducer. These classes will be randomly used by Simple CAPTCHA to generate text for a captcha image.

Default: "com.liferay.captcha.simplecaptcha.PinNumberTextProducer|nl.captcha.text.producer.DefaultTextProducer|nl.captcha.text.producer.FiveLetterFirstNameTextProducer"
simpleCaptchaWidth number

Set the width for captcha images generated by Simple CAPTCHA.

Default: 150
simpleCaptchaWordRenderers string[]

Input class names that implement nl.captcha.text.renderer.WordRenderer. These classes will be randomly used by Simple CAPTCHA to render text for a captcha image.

Default: "nl.captcha.text.renderer.DefaultWordRenderer"
14. object object
captchaName string required
captchaResponseParameterName string required
customElementExternalReferenceCode string required
oAuth2ApplicationExternalReferenceCode string required
pid const: "com.liferay.captcha.internal.configuration.FunctionCaptchaImplConfiguration" required
Constant: "com.liferay.captcha.internal.configuration.FunctionCaptchaImplConfiguration"
resourcePath string required
15. Publications Email Notifications object
pid const: "com.liferay.change.tracking.configuration.CTCollectionEmailConfiguration" required
Constant: "com.liferay.change.tracking.configuration.CTCollectionEmailConfiguration"
emailFromAddress string
Default: ""
emailFromName string
Default: ""
invitationEmailBody object

Provide a localized template for the body of user invitation emails.

invitationEmailSubject object

Provide a localized template for the subject of user invitation emails.

16. Publications Settings object
pid const: "com.liferay.change.tracking.configuration.CTSettingsConfiguration" required
Constant: "com.liferay.change.tracking.configuration.CTSettingsConfiguration"
defaultCTCollectionTemplateId number
Default: 0
defaultOwnerActionIds string[]
defaultSandboxCTCollectionTemplateId number
Default: 0
enabled boolean
Default: false
modificationDeletionConflictCheckEnabled boolean

Check this option to automatically check all modification deletion conflicts by default. This will let you review any deletion conflicts and prevent Liferay from overwriting deletions made in a publication when updating production.

Default: false
remoteClientId string
remoteClientSecret string
remoteEnabled boolean
Default: false
sandboxEnabled boolean
Default: false
schemaVersionCheckEnabled boolean

Enabling the schema version check will allow unpublished publications to go out of date after an upgrade.

Default: false
unapprovedChangesAllowed boolean
Default: false
17. Publications View Changes object
pid const: "com.liferay.change.tracking.web.internal.configuration.CTConfiguration" required
Constant: "com.liferay.change.tracking.web.internal.configuration.CTConfiguration"
hiddenApplications string[]

These applications will be hidden from the application menu when you are in a publication.

productionOnlyApplication string[]

These applications do not participate in a publication. Any data saved will be saved directly into production.

Default: "com_liferay_dispatch_web_internal_portlet_DispatchPortlet, com_liferay_my_account_web_portlet_MyAccountPortlet, com_liferay_notification_web_internal_portlet_NotificationTemplatesPortlet, com_liferay_oauth_client_admin_web_internal_portlet_OAuthClientAdminPortlet, com_liferay_oauth2_provider_web_internal_portlet_OAuth2AdminPortlet, com_liferay_object_web_internal_object_definitions_portlet_ObjectDefinitionsPortlet, com_liferay_object_web_internal_list_type_portlet_portlet_ListTypeDefinitionsPortlet, com_liferay_password_policies_admin_web_portlet_PasswordPoliciesAdminPortlet, com_liferay_portal_language_override_web_internal_portlet_PLOPortlet, com_liferay_portal_search_tuning_rankings_web_internal_portlet_ResultRankingsPortlet, com_liferay_portal_search_tuning_synonyms_web_internal_portlet_SynonymsPortlet, com_liferay_search_experiences_web_internal_blueprint_admin_portlet_SXPBlueprintAdminPortlet, com_liferay_users_admin_web_portlet_UsersAdminPortlet"
showAllData boolean

Show all data in the data tab when reviewing a change as an administrator.

unsupportedApplication string[]

These applications do not support publications. Any data saved in a publication will result in an error.

Default: "com_liferay_account_admin_web_internal_portlet_AccountEntriesAdminPortlet, com_liferay_batch_planner_web_internal_portlet_BatchPlannerPortlet"
18. Click to Chat Configuration object
chatProviderAccountId string required
chatProviderId string required
chatProviderKeyId string required
chatProviderSecretKey string required
enabled boolean required
guestUsersAllowed boolean required
hideInControlPanel boolean required
pid const: "com.liferay.click.to.chat.web.internal.configuration.ClickToChatConfiguration" required
Constant: "com.liferay.click.to.chat.web.internal.configuration.ClickToChatConfiguration"
siteSettingsStrategy string required
19. object object
baseURL string required
name string required
pid const: "com.liferay.client.extension.type.configuration.CETConfiguration" required
Constant: "com.liferay.client.extension.type.configuration.CETConfiguration"
type string required
buildTimestamp number
description string
properties string[]
sourceCodeURL string
typeSettings string[]
20. Commerce Payment Entry Audit object
pid const: "com.liferay.commerce.payment.configuration.CommercePaymentEntryAuditConfiguration" required
Constant: "com.liferay.commerce.payment.configuration.CommercePaymentEntryAuditConfiguration"
enabled boolean
Default: true
21. Refund Reasons object
key string required
pid const: "com.liferay.commerce.payment.configuration.CommercePaymentEntryRefundTypeConfiguration" required
Constant: "com.liferay.commerce.payment.configuration.CommercePaymentEntryRefundTypeConfiguration"
enabled boolean
Default: true
name object
priority number
22. Product Configurations object
pid const: "com.liferay.commerce.product.configuration.CPConfigurationListRelConfiguration" required
Constant: "com.liferay.commerce.product.configuration.CPConfigurationListRelConfiguration"
cpConfigurationListDiscovery string
23. Product Options object
pid const: "com.liferay.commerce.product.configuration.CPDefinitionOptionRelConfiguration" required
Constant: "com.liferay.commerce.product.configuration.CPDefinitionOptionRelConfiguration"
showUnselectableOptions boolean
Default: false
24. Friendly URL object
pid const: "com.liferay.commerce.product.configuration.CPFriendlyURLConfiguration" required
Constant: "com.liferay.commerce.product.configuration.CPFriendlyURLConfiguration"
assetCategoryURLSeparator string

Do not change it in production as you will introduce SEO issues.

Default: "g"
productURLSeparator string

You must restart portal after this change. Do not change it in production as you will introduce SEO issues.

Default: "p"
25. Product Versioning object
pid const: "com.liferay.commerce.product.configuration.CProductVersionConfiguration" required
Constant: "com.liferay.commerce.product.configuration.CProductVersionConfiguration"
enabled boolean
Default: false
versionThreshold number
Default: 5
26. Account Qualifiers object
pid const: "com.liferay.commerce.qualifier.configuration.AccountEntryCommerceQualifierConfiguration" required
Constant: "com.liferay.commerce.qualifier.configuration.AccountEntryCommerceQualifierConfiguration"
allowedTargetKeys string[]
orderByTargetKeys string[]
27. Account Group Qualifiers object
pid const: "com.liferay.commerce.qualifier.configuration.AccountGroupCommerceQualifierConfiguration" required
Constant: "com.liferay.commerce.qualifier.configuration.AccountGroupCommerceQualifierConfiguration"
allowedTargetKeys string[]
orderByTargetKeys string[]
28. Address Qualifiers object
pid const: "com.liferay.commerce.qualifier.configuration.AddressCommerceQualifierConfiguration" required
Constant: "com.liferay.commerce.qualifier.configuration.AddressCommerceQualifierConfiguration"
allowedTargetKeys string[]
orderByTargetKeys string[]
29. Commerce Order Rule Qualifiers object
pid const: "com.liferay.commerce.qualifier.configuration.COREntryCommerceQualifierConfiguration" required
Constant: "com.liferay.commerce.qualifier.configuration.COREntryCommerceQualifierConfiguration"
allowedTargetKeys string[]
Default: "account|account-group,channel,order-type"
orderByTargetKeys string[]
Default: "account|order-type|channel,account|order-type,account|channel,account,account-group|order-type|channel,account-group|order-type,account-group|channel,account-group,order-type|channel,order-type,channel"
30. Commerce Channel Qualifiers object
pid const: "com.liferay.commerce.qualifier.configuration.CommerceChannelCommerceQualifierConfiguration" required
Constant: "com.liferay.commerce.qualifier.configuration.CommerceChannelCommerceQualifierConfiguration"
allowedTargetKeys string[]
orderByTargetKeys string[]
31. Commerce Currency Qualifiers object
pid const: "com.liferay.commerce.qualifier.configuration.CommerceCurrencyCommerceQualifierConfiguration" required
Constant: "com.liferay.commerce.qualifier.configuration.CommerceCurrencyCommerceQualifierConfiguration"
allowedTargetKeys string[]
orderByTargetKeys string[]
32. Commerce Discount Qualifiers object
pid const: "com.liferay.commerce.qualifier.configuration.CommerceDiscountCommerceQualifierConfiguration" required
Constant: "com.liferay.commerce.qualifier.configuration.CommerceDiscountCommerceQualifierConfiguration"
allowedTargetKeys string[]
Default: "account|account-group,channel,order-type"
orderByTargetKeys string[]
Default: "account|order-type|channel,account|order-type,account|channel,account,account-group|order-type|channel,account-group|order-type,account-group|channel,account-group,order-type|channel,order-type,channel"
33. Commerce Inventory Warehouse Qualifiers object
pid const: "com.liferay.commerce.qualifier.configuration.CommerceInventoryWarehouseCommerceQualifierConfiguration" required
Constant: "com.liferay.commerce.qualifier.configuration.CommerceInventoryWarehouseCommerceQualifierConfiguration"
allowedTargetKeys string[]
orderByTargetKeys string[]
34. Commerce Order Type Qualifiers object
pid const: "com.liferay.commerce.qualifier.configuration.CommerceOrderTypeCommerceQualifierConfiguration" required
Constant: "com.liferay.commerce.qualifier.configuration.CommerceOrderTypeCommerceQualifierConfiguration"
allowedTargetKeys string[]
Default: "channel"
orderByTargetKeys string[]
Default: "channel"
35. Commerce Payment Method Group Rel Qualifiers object
pid const: "com.liferay.commerce.qualifier.configuration.CommercePaymentMethodGroupRelCommerceQualifierConfiguration" required
Constant: "com.liferay.commerce.qualifier.configuration.CommercePaymentMethodGroupRelCommerceQualifierConfiguration"
allowedTargetKeys string[]
Default: "order-type"
orderByTargetKeys string[]
Default: "order-type"
36. Commerce Price List Qualifiers object
pid const: "com.liferay.commerce.qualifier.configuration.CommercePriceListCommerceQualifierConfiguration" required
Constant: "com.liferay.commerce.qualifier.configuration.CommercePriceListCommerceQualifierConfiguration"
allowedTargetKeys string[]
Default: "account|account-group,channel,order-type"
orderByTargetKeys string[]
Default: "account|order-type|channel,account|order-type,account|channel,account,account-group|order-type|channel,account-group|order-type,account-group|channel,account-group,order-type|channel,order-type,channel"
37. Commerce Shipping Fixed Option Qualifiers object
pid const: "com.liferay.commerce.qualifier.configuration.CommerceShippingFixedOptionCommerceQualifierConfiguration" required
Constant: "com.liferay.commerce.qualifier.configuration.CommerceShippingFixedOptionCommerceQualifierConfiguration"
allowedTargetKeys string[]
Default: "order-type"
orderByTargetKeys string[]
Default: "order-type"
38. Commerce Term Qualifiers object
pid const: "com.liferay.commerce.qualifier.configuration.CommerceTermEntryCommerceQualifierConfiguration" required
Constant: "com.liferay.commerce.qualifier.configuration.CommerceTermEntryCommerceQualifierConfiguration"
allowedTargetKeys string[]
Default: "order-type"
orderByTargetKeys string[]
Default: "order-type"
39. Digital Signature Configuration object
accountBaseURI string required
apiAccountId string required
apiUsername string required
enabled boolean required
environment string required
integrationKey string required
pid const: "com.liferay.digital.signature.configuration.DigitalSignatureConfiguration" required
Constant: "com.liferay.digital.signature.configuration.DigitalSignatureConfiguration"
rsaPrivateKey string required
siteSettingsStrategy string required
40. Google Cloud Vision Image Auto Tagging object

Auto tags images using the Google Cloud Vision API.

apiKey string required

Set the API key for the Google Cloud Vision API. Billing must be enabled for this API to work. See {0} for more information.

pid const: "com.liferay.document.library.asset.auto.tagger.google.cloud.vision.internal.configuration.GCloudVisionAssetAutoTagProviderCompanyConfiguration" required

Auto tags images using the Google Cloud Vision API.

Constant: "com.liferay.document.library.asset.auto.tagger.google.cloud.vision.internal.configuration.GCloudVisionAssetAutoTagProviderCompanyConfiguration"
enabled boolean

Enable auto tagging of images in the document library using the Google Cloud Vision API.

41. Microsoft Cognitive Services Image Auto Tagging object

Auto tags images using the Microsoft Cognitive Services Computer Vision API V2.

apiEndpoint string required

Set the endpoint for the Computer Vision API V2 (e.g. {0}). See {1} for more information.

apiKey string required

Set the API key for the Computer Vision API V2. See {0} for more information.

pid const: "com.liferay.document.library.asset.auto.tagger.microsoft.cognitive.services.internal.configuration.MSCognitiveServicesAssetAutoTagProviderCompanyConfiguration" required

Auto tags images using the Microsoft Cognitive Services Computer Vision API V2.

Constant: "com.liferay.document.library.asset.auto.tagger.microsoft.cognitive.services.internal.configuration.MSCognitiveServicesAssetAutoTagProviderCompanyConfiguration"
enabled boolean

Enable auto tagging of images in the document library using Microsoft Cognitive Services.

42. TensorFlow Image Auto Tagging object

TensorFlow Image Auto Tagging is based on an open source model (Inception 5h). Its accuracy might be limited so please use with caution.

pid const: "com.liferay.document.library.asset.auto.tagger.tensorflow.internal.configuration.TensorFlowImageAssetAutoTagProviderCompanyConfiguration" required

TensorFlow Image Auto Tagging is based on an open source model (Inception 5h). Its accuracy might be limited so please use with caution.

Constant: "com.liferay.document.library.asset.auto.tagger.tensorflow.internal.configuration.TensorFlowImageAssetAutoTagProviderCompanyConfiguration"
confidenceThreshold number

Set the minimum confidence threshold (from 0 to 1) above which tags will be applied.

Default: 0.1
enabled boolean

Enable auto tagging of images in the document library using TensorFlow.

Default: false
43. File Entry Friendly URL object
pid const: "com.liferay.document.library.configuration.DLFileEntryFriendlyURLConfiguration" required
Constant: "com.liferay.document.library.configuration.DLFileEntryFriendlyURLConfiguration"
enableFriendlyURLWithExtension boolean

Add the file extension to the file entry friendly URL by default.

Default: false
44. Mime Type object
pid const: "com.liferay.document.library.configuration.DLFileEntryMimeTypeConfiguration" required
Constant: "com.liferay.document.library.configuration.DLFileEntryMimeTypeConfiguration"
fileMimeTypes string[]

A file mime type of * will permit all file mime types.

Default: "*"
45. Google Drive object
clientId string required

Set the OAuth 2 client id for the Google Drive API. Go to {0} to create it.

clientSecret string required

Set the OAuth 2 client secret for the Google Drive API. Go to {0} to create it.

pid const: "com.liferay.document.library.google.drive.configuration.DLGoogleDriveCompanyConfiguration" required
Constant: "com.liferay.document.library.google.drive.configuration.DLGoogleDriveCompanyConfiguration"
pickerAPIKey string

Set the API Key for the Google Picker API. Go to {0} to create it.

46. Indexer object
pid const: "com.liferay.document.library.internal.configuration.DLIndexerConfiguration" required
Constant: "com.liferay.document.library.internal.configuration.DLIndexerConfiguration"
cacheTextExtraction boolean
Default: true
47. OneDrive object
clientId string required

Set the OAuth 2 client id for the OneDrive API. Go to {0} to create it.

clientSecret string required

Set the OAuth 2 client secret for the OneDrive API. Go to {0} to create it.

pid const: "com.liferay.document.library.opener.onedrive.web.internal.configuration.DLOneDriveCompanyConfiguration" required
Constant: "com.liferay.document.library.opener.onedrive.web.internal.configuration.DLOneDriveCompanyConfiguration"
tenant string required

Set the tenant for the OneDrive API. Go to {0} to obtain it.

48. Cache Control object
cacheControl string required

Set the cache control policy for documents with view permissions for guests.

Default: "must-revalidate"
pid const: "com.liferay.document.library.web.internal.configuration.CacheControlConfiguration" required
Constant: "com.liferay.document.library.web.internal.configuration.CacheControlConfiguration"
maxAge number

Set the number of seconds after a response is generated in which a response will be considered fresh.

Default: 600
notCacheableMimeTypes string[]

Set a list of mime types that will be uncacheable.

49. Export/Import, Staging object

The settings in this configuration let you control the export/import, staging, and site template propagation processes.

pid const: "com.liferay.exportimport.configuration.ExportImportServiceConfiguration" required

The settings in this configuration let you control the export/import, staging, and site template propagation processes.

Constant: "com.liferay.exportimport.configuration.ExportImportServiceConfiguration"
includeAllAssetLinks boolean

If checked, all asset links are included from the site within the given date range. Uncheck to include only those asset links which are connected to the content.

Default: false
includeThumbnailsAndPreviewsDuringStaging boolean

If checked, then the generated previews and thumbnails will be included during the staging process.

Default: true
publishPermissionsByDefault boolean

If checked, the permissions assigned for the exported pages and individual portlet windows are always included by default.

Default: false
replicateIndividualDeletionsByDefault boolean

If checked, the delete operations performed for content types will be always replicated in the target site by default.

Default: false
showAdvancedStagingConfigurationByDefault boolean

If checked, then the advanced publication configuration screen will be displayed by default when publishing pages.

Default: false
validateFileEntryReferences boolean

If checked, publishing or importing some types of content with text in them will cause Liferay to check the content for any links to documents, and ensure that each of these links points to a valid document.

Default: true
validateJournalFeedReferences boolean

If checked, publishing or importing some types of content with text in them will cause Liferay to check the content for any references to web content feeds, and ensure that each one of these references points to a valid feed.

Default: true
validateLayoutReferences boolean

If checked, publishing or importing some types of content with text in them will cause Liferay to check the content for any links that reference one of the portal's virtual hosts, and ensure that each of these links points to a valid page within Liferay. Uncheck this if your virtual host has pages not in Liferay.

Default: true
validateLayoutReferencesWhitelistedURLPatterns string[]

Specify a URL pattern that will be whitelisted when validating layout references. URLs that match this pattern will always pass the validation even if they do not point to a valid Liferay page.

validateMissingReferences boolean

If checked, publishing or importing will cause Liferay to check missing references. If unchecked, missing reference validation is skipped. As a result, references without existing targets can be published or imported to the target site.

Default: true
50. Flags object
pid const: "com.liferay.flags.configuration.FlagsGroupServiceConfiguration" required
Constant: "com.liferay.flags.configuration.FlagsGroupServiceConfiguration"
emailBody string
Default: "com/liferay/flags/dependencies/email_flag_body.tmpl"
emailEntryAddedEnabled boolean
Default: true
emailFromAddress string
emailFromName string
emailSubject string
Default: "com/liferay/flags/dependencies/email_flag_subject.tmpl"
guestUsersEnabled boolean
Default: false
reasons string[]
Default: "sexual-content|violent-or-repulsive-content|hateful-or-abusive-content|harmful-dangerous-acts|spam|infringes-my-rights"
51. Javascript object
pid const: "com.liferay.fragment.configuration.FragmentJavaScriptConfiguration" required
Constant: "com.liferay.fragment.configuration.FragmentJavaScriptConfiguration"
javaScriptModuleEnabled boolean

When enabled, fragment JavaScript is embedded in a script as a module instead of as a function.

Default: true
52. Page Fragments object
pid const: "com.liferay.fragment.configuration.FragmentServiceConfiguration" required
Constant: "com.liferay.fragment.configuration.FragmentServiceConfiguration"
propagateChanges boolean

When enabled, changes will be propagated immediately after publishing a fragment entry. If staging is enabled, this setting does not affect live sites.

Default: false
propagateContributedFragmentChanges boolean

When enabled, changes will be propagated immediately during the deploy process. When disabled, changes can be propagated manually after deploy process.

Default: true
53. FreeMarker Fragment Entry Processor object
pid const: "com.liferay.fragment.entry.processor.freemarker.internal.configuration.FreeMarkerFragmentEntryProcessorConfiguration" required
Constant: "com.liferay.fragment.entry.processor.freemarker.internal.configuration.FreeMarkerFragmentEntryProcessorConfiguration"
enable boolean

Enable this to allow fragment authors to use FreeMarker.

Default: true
54. Fragment Thumbnails object
pid const: "com.liferay.fragment.web.internal.configuration.FragmentPortletConfiguration" required
Constant: "com.liferay.fragment.web.internal.configuration.FragmentPortletConfiguration"
thumbnailExtensions string[]
Default: ".gif,.jpeg,.jpg,.png,.svg"
55. Friendly URL Redirection object

Choose the default redirection type to use when old friendly URLs are referenced for display page templates or pages.

pid const: "com.liferay.friendly.url.configuration.FriendlyURLRedirectionConfiguration" required

Choose the default redirection type to use when old friendly URLs are referenced for display page templates or pages.

Constant: "com.liferay.friendly.url.configuration.FriendlyURLRedirectionConfiguration"
redirectionType string

This type of redirect will be used when a page or piece of content using a display page template is accessed using an old friendly URL.

Default: "temporary"
Values: "permanent" "temporary"
showAlternativeLayoutFriendlyURLMessage boolean

Enable to show a message when you are redirected to a different layout friendly URL.

Default: true
56. object object
pid const: "com.liferay.friendly.url.configuration.FriendlyURLSeparatorCompanyConfiguration" required
Constant: "com.liferay.friendly.url.configuration.FriendlyURLSeparatorCompanyConfiguration"
friendlyURLSeparatorsJSON string
Default: "{}"
57. Frontend SPA Infrastructure object

For changes made here to take effect, you must reload the browser page after saving.

pid const: "com.liferay.frontend.js.spa.web.internal.configuration.SPAConfiguration" required

For changes made here to take effect, you must reload the browser page after saving.

Constant: "com.liferay.frontend.js.spa.web.internal.configuration.SPAConfiguration"
cacheExpirationTime number

Define the time, in minutes, in which the SPA cache is cleared. Use a zero value if the cache should never expire during SPA navigation. Use a negative value if the cache should be disabled.

Default: -1
customExcludedPaths string[]

Define the custom paths that SPA should ignore.

enabled boolean

If this is checked, the single page application framework will allow for faster navigation between pages.

Default: true
navigationExceptionSelectors string[]

Define the CSS selectors that SPA should ignore.

Default: ":not([target=\"
preloadCSS boolean

Preload CSS resources before applying UI changes. This will prevent FOUC (flash of unstyled content) at the expense of making UI updates slower.

Default: false
requestTimeout number

Define the time, in milliseconds, in which a SPA request times out. Use a zero value if the request should never timeout.

Default: 0
userNotificationTimeout number

Define the time, in milliseconds, in which a notification is shown to the user stating that the request is taking longer than expected. Set to 0 if no notification should be shown.

Default: 30000
58. Custom Dialogs object
pid const: "com.liferay.frontend.js.web.internal.configuration.CustomDialogsSettingsConfiguration" required
Constant: "com.liferay.frontend.js.web.internal.configuration.CustomDialogsSettingsConfiguration"
enabled boolean
Default: false
59. Frontend Caching object
pid const: "com.liferay.frontend.js.web.internal.configuration.FrontendCachingConfiguration" required
Constant: "com.liferay.frontend.js.web.internal.configuration.FrontendCachingConfiguration"
cachingStrategy string

Set the balance between caching span and size of the import maps (which affect the size of the page's HTML). If you decide not to use hashes, the import maps will be smaller but the caching span will be limited. On the other hand, if you use one hash per file, the import maps will be bigger but files will be infinitely cacheable.

Default: "do-not-use-hashes"
cssStyleSheetsMaxAge number

Set the value of the "max-age" directive in the "Cache-Control" header for mutable CSS style sheets.

Default: 86400
jsFilesMaxAge number

Set the value of the "max-age" directive in the "Cache-Control" header for mutable JavaScript files.

Default: 86400
labelsModulesMaxAge number

Set the value of the "max-age" directive in the "Cache-Control" header for labels modules.

Default: 3600
sendNoCacheForCSSStyleSheets boolean

If checked, a "no-cache" directive (instead of "must-revalidate") will be sent in the "Cache-Control" header for CSS style sheets.

Default: false
sendNoCacheForJSFiles boolean

If checked, a "no-cache" directive (instead of "must-revalidate") will be sent in the "Cache-Control" header for JavaScript files.

Default: false
sendNoCacheForLabelsModules boolean

If checked, a "no-cache" directive (instead of "must-revalidate") will be sent in the "Cache-Control" header for labels modules.

Default: false
sendNoCacheForTokenizedCSSStyleSheets boolean

If checked, a "no-cache" directive (instead of "must-revalidate") will be sent in the "Cache-Control" header for CSS style sheets that contain tokens (e.g. "@theme_image_path@").

Default: false
sendNoCacheForTranslatedJSFiles boolean

If checked, a "no-cache" directive (instead of "must-revalidate") will be sent in the "Cache-Control" header for translated JavaScript files (those that contain invocations to "Liferay.Language.get()" and do not have an associated language.json file).

Default: false
tokenizedCSSStyleSheetsMaxAge number

Set the value of the "max-age" directive in the "Cache-Control" header for CSS style sheets that contain tokens (e.g. "@theme_image_path@").

Default: 86400
translatedJSFilesMaxAge number

Set the value of the "max-age" directive in the "Cache-Control" header for translated JavaScript files for translated JavaScript files (those that contain invocations to "Liferay.Language.get()" and do not have an associated language.json file).

Default: 3600
60. Liferay Global Object object
pid const: "com.liferay.frontend.js.web.internal.configuration.LiferayGlobalObjectConfiguration" required
Constant: "com.liferay.frontend.js.web.internal.configuration.LiferayGlobalObjectConfiguration"
disableGetRemoteMethods boolean

If checked, the methods getRemoteAddr() and getRemoteHost() will be undefined within the Liferay.ThemeDisplay global object. This configuration is primarily implemented to mitigate privacy risks by avoiding the exposure of client IP/host information and to optimize performance by allowing public caching of pages for unauthenticated users. Note that checking this option will make custom code that relies on these methods fail.

Default: false
61. Web Content object
pid const: "com.liferay.journal.configuration.JournalServiceConfiguration" required
Constant: "com.liferay.journal.configuration.JournalServiceConfiguration"
addDefaultStructures boolean
Default: true
articleCommentsEnabled boolean

Set this to true to enable comments for journal articles.

Default: true
autogenerateDDMStructureKey boolean

Check this if structure keys should always be autogenerated.

Default: true
autogenerateDDMTemplateKey boolean

Check this if template keys should always be autogenerated.

Default: true
charactersblacklist string[]

Specify characters that are not allowed in web content folder names.

Default: "&|\\'|@|\\\\|]|}|:|=|>|/|<|[|{|%|+|#|`|?|\\\"
checkInterval number

Set the check interval in minutes.

Default: 15
customTokenNames string[]

Set a list of custom token names that will be replaced when article content is rendered.

Default: ""
customTokenValues string[]

Set a list of custom token values that will be replaced when article content is rendered.

Default: ""
displayFieldName boolean
Default: false
enableContentTransformerListener boolean
Default: false
errorTemplateFTL string
expireAllArticleVersionsEnabled boolean

Set this to true to expire all article versions when expiring an article. Set this to false to only expire the latest approved article version when expiring an article.

Default: true
indexAllArticleVersionsEnabled boolean

Set this to true to index all article versions. Set this to false to index only the last indexable version.

Default: true
journalArticleExportImportProcessorCacheEnabled boolean

Specify whether processed web content will be cached and reused when running an export or a publish process. Setting this to true will speed up export or publish processes involving web content, but will increase memory usage. The cache size and timeout may be configured for the cache using the cache name "com.liferay.journal.internal.exportimport.content.processor.JournalArticleExportImportProcessorCache".

Default: true
journalArticleMaxVersionCount number
Default: 0
journalArticlePageBreakToken string

Set the token used when inserting simple page breaks in articles.

Default: "@page_break@"
publishToLiveByDefaultEnabled boolean

Set this to true if web content articles should be published to live by default.

Default: true
singleAssetPublishIncludeVersionHistory boolean

Set whether the web content version history should be included in single asset publish processes.

Default: false
termsOfUseJournalArticleGroupId number
Default: 0
termsOfUseJournalArticleId string
Default: ""
versionHistoryByDefaultEnabled boolean

Set this to false if only the latest approved version of web content articles should be published by default.

Default: true
62. Page Editor object
pid const: "com.liferay.layout.content.page.editor.web.internal.configuration.PageEditorConfiguration" required
Constant: "com.liferay.layout.content.page.editor.web.internal.configuration.PageEditorConfiguration"
autoExtendSessionEnabled boolean

Enabling will automatically extend the session while the page editor is opened.

Default: true
maxNumberOfItemsInEditMode number

The maximum number of items that are shown in a collection are limited in the Edit mode, due to page render performance. This limit does not affect the collection visualization in the published page. Please be aware that increasing this value might have a negative impact on the performance of the Edit mode of a Content Page.

Default: 20
63. Locked Pages object
pid const: "com.liferay.layout.locked.layouts.web.internal.configuration.LockedLayoutsCompanyConfiguration" required
Constant: "com.liferay.layout.locked.layouts.web.internal.configuration.LockedLayoutsCompanyConfiguration"
allowAutomaticUnlockingProcess boolean
Default: true
autosaveMinutes number
Default: 5
64. Google PageSpeed Insights object

Google PageSpeed Insights can find accessibility and SEO issues in your pages, and provide suggestions to fix them.

pid const: "com.liferay.layout.reports.web.internal.configuration.LayoutReportsGooglePageSpeedCompanyConfiguration" required

Google PageSpeed Insights can find accessibility and SEO issues in your pages, and provide suggestions to fix them.

Constant: "com.liferay.layout.reports.web.internal.configuration.LayoutReportsGooglePageSpeedCompanyConfiguration"
enabled boolean
Default: true
65. SEO object

SEO Configuration

pid const: "com.liferay.layout.seo.internal.configuration.LayoutSEOCompanyConfiguration" required

SEO Configuration

Constant: "com.liferay.layout.seo.internal.configuration.LayoutSEOCompanyConfiguration"
canonicalURL string

Selecting "Use Default Language URL" will make all pages use as canonical URL the URL set for the default language of the site. Selecting "Use Localized URL" will set for each localized page the URL corresponding to its language as canonical URL.

Default: "default-language-url"
Values: "default-language-url" "localized-url"
enableLayoutTranslatedLanguages boolean

Generate Hreflang metadata only for languages with translated content.

Default: false
enableOpenGraph boolean

Enabling will embed Open Graph meta tags on every page so that content can be shared on applications supporting this protocol (e.g. Facebook, Twitter, Slack, etc.).

Default: true
66. Site Templates object

Site Templates Configuration

pid const: "com.liferay.layout.set.prototype.configuration.LayoutSetPrototypeConfiguration" required

Site Templates Configuration

Constant: "com.liferay.layout.set.prototype.configuration.LayoutSetPrototypeConfiguration"
cancelPropagationImportTask boolean

If checked, old site template propagation import tasks will be cancelled when new ones are already scheduled for the same site. This can help to optimize the site template propagation process, when the template itself is frequently changed, and the propagation is also frequently triggered. This way, the sites will only be updated with the latest version of the template.

Default: true
67. Outlook Auth Connector object
clientId string required

Set the OAuth 2 client ID for the Outlook API.

clientSecret string required

Set the OAuth 2 client secret for the Outlook API.

pid const: "com.liferay.mail.outlook.auth.connector.provider.internal.configuration.MailOutlookAuthConnectorCompanyConfiguration" required
Constant: "com.liferay.mail.outlook.auth.connector.provider.internal.configuration.MailOutlookAuthConnectorCompanyConfiguration"
pop3ConnectionEnabled boolean required

If enabled, the POP3 connection will use OAuth 2 as the authentication mechanism.

Default: false
smtpConnectionEnabled boolean required

If enabled, the SMTP connection will use OAuth 2 as the authentication mechanism.

Default: false
tenantId string required

Set the tenant ID for the Outlook API. Go to {0} to obtain it.

68. Mail Settings object
pid const: "com.liferay.mail.settings.configuration.MailSettingCompanyConfiguration" required
Constant: "com.liferay.mail.settings.configuration.MailSettingCompanyConfiguration"
additionalJavaMailProperties string

Manually specify additional JavaMail properties to override the existing configuration.

Default: ""
enablePOPServerNotifications boolean
Default: false
enableStartTLS boolean
Default: true
incomingPOPPort string
Default: "110"
incomingPOPServer string
Default: "localhost"
outgoingSMTPPort string
Default: "25"
outgoingSMTPServer string
Default: "localhost"
popPassword string
Default: ""
popUserName string
Default: ""
smtpPassword string
Default: ""
smtpUserName string
Default: ""
storeProtocol string
Default: "pop3"
transportProtocol string
Default: "smtp"
69. Multi-Factor Authentication and Email One-Time Password Configuration object
pid const: "com.liferay.multi.factor.authentication.email.otp.configuration.MFAEmailOTPConfiguration" required
Constant: "com.liferay.multi.factor.authentication.email.otp.configuration.MFAEmailOTPConfiguration"
emailFromAddress string

Set the sender address on the one-time password email.

emailFromName string
emailOTPSentBody object
emailOTPSentSubject object
enabled boolean

Enabling multi-factor authentication implies enabling Email One-Time Password. It is strongly advised that other forms of user authentication that only support a single factor are disabled (e.g. Basic, Digest, WEBDAV).

Default: false
failedAttemptsAllowed number

Set the number of verification attempts allowed before blocking for the retry timeout.

Default: -1
order number

Set the multi-factor authentication checker order. Checkers with higher order will be shown first.

Default: 10
otpSize number

Set the length of a one-time password.

Default: 6
resendEmailTimeout number

Set the allowed time in seconds between one-time password requests.

Default: 30
retryTimeout number

Set the time in seconds to block requests after reaching the limit for failed attempts allowed.

Default: -1
70. Fast IDentity Online 2 Configuration object
pid const: "com.liferay.multi.factor.authentication.fido2.web.internal.configuration.MFAFIDO2Configuration" required
Constant: "com.liferay.multi.factor.authentication.fido2.web.internal.configuration.MFAFIDO2Configuration"
allowOriginPort boolean

Enable to relax the origin matching rule to allow any port number.

Default: false
allowOriginSubdomain boolean

Enable to relax the origin matching rule to allow any subdomain, of any depth.

Default: false
allowedCredentialsPerUser number

Set the number of allowed credentials per user.

Default: 1
enabled boolean

Enable Fast IDentity Online 2.

Default: false
order number

Set the multi-factor authentication checker order. Checkers with higher order will be shown first.

Default: 200
origins string[]

Set the allowed origins that returned authenticator responses will be compared against. The default is the set containing only the string of "https://" + Relying Party ID.

Default: "https://localhost"
relyingPartyId string

Set the relying party ID. It must be equal to the origin's effective domain, or a registrable domain suffix of the origin's effective domain. For example an origin of https://login.example.com:1337 can only have relying party ID as one of the following: login.example.com or example.com. This is done in order to match the behavior of pervasively deployed ambient credentials (e.g. cookies, [RFC6265]).

Default: "localhost"
relyingPartyName string

Set the relying party name.

Default: "relying Party"
71. IP Address Configuration object
pid const: "com.liferay.multi.factor.authentication.ip.address.internal.configuration.MFAIPAddressConfiguration" required
Constant: "com.liferay.multi.factor.authentication.ip.address.internal.configuration.MFAIPAddressConfiguration"
allowedIPAddressAndNetMask string[]

Set the allowed IP address and the network mask (can be either IPv4 or IPv6). Use the add button to add multiple ones.

Default: "127.0.0.1/255.0.0.0"
enabled boolean

When the IP address configuration is enabled, the instance will check if the user tries to log in from a valid network ip and will allow the access the portal without showing any other multi-factor authentication verifiers.

Default: false
72. MFA Sample Configuration object
pid const: "com.liferay.multi.factor.authentication.sample.internal.configuration.MFASampleConfiguration" required
Constant: "com.liferay.multi.factor.authentication.sample.internal.configuration.MFASampleConfiguration"
enabled boolean
Default: false
order number
Default: 400
73. Time-Based One-Time Password Configuration object
pid const: "com.liferay.multi.factor.authentication.timebased.otp.web.internal.configuration.MFATimeBasedOTPConfiguration" required
Constant: "com.liferay.multi.factor.authentication.timebased.otp.web.internal.configuration.MFATimeBasedOTPConfiguration"
algorithmKeySize number

Set the size of the algorithm key.

Default: 20
clockSkew number

Set the time in milliseconds that the clocks can differ before a code will be rejected. This means the checker could perform a validation against the current time and then two further validations (+ clock skew time / - clock skew time).

Default: 3000
emailTOTPReuseAttemptWarningBody object
emailTOTPReuseAttemptWarningFromAddress string

Set the sender address on the time-based one-time password reuse attempt warning email.

emailTOTPReuseAttemptWarningFromName string
emailTOTPReuseAttemptWarningSubject object
enabled boolean

Enable time-based one-time password. Take into account that time-based one-time password also needs to be configured by each user. They will find a new section to configure it at "Account Settings".

Default: false
order number

Set the multi-factor authentication checker order. Checkers with higher order will be shown first.

Default: 100
74. OAuth 2 Incoming Assertion Configuration object
issuer string required

OAuth 2 Incoming Assertion Issuer

pid const: "com.liferay.oauth2.provider.rest.internal.configuration.OAuth2InAssertionConfiguration" required
Constant: "com.liferay.oauth2.provider.rest.internal.configuration.OAuth2InAssertionConfiguration"
signatureJSONWebKeySet string required

Input signature verification keys in JWKS format. In a typical scenario, one can retrieve them from an assertion issuer's JWKS endpoint.

userAuthType string required

Choose one of the following types to authenticate a user. Assertion issuer must configure assertion's "sub" claim to the same type.

Default: "UUID"
Values: "emailAddress" "screenName" "userId" "UUID"
75. Authorize Screen object
pid const: "com.liferay.oauth2.provider.rest.internal.endpoint.authorize.configuration.AuthorizeScreenConfiguration" required
Constant: "com.liferay.oauth2.provider.rest.internal.endpoint.authorize.configuration.AuthorizeScreenConfiguration"
authorizeScreenURL string

Set the URL to screen where users approve authorization.

Default: "/?p_p_id=com_liferay_oauth2_provider_web_internal_portlet_OAuth2AuthorizePortlet&p_p_state=maximized"
loginURL string

Set the URL where users can authenticate.

Default: "/c/portal/login"
76. Object object
pid const: "com.liferay.object.configuration.ObjectConfiguration" required
Constant: "com.liferay.object.configuration.ObjectConfiguration"
duration number
Default: 1
maximumFileSizeForGuestUsers number

Set the maximum file size (in megabytes) that a guest user can upload through attachment fields in an object entry.

Default: 25
maximumNumberOfGuestUserObjectEntriesPerObjectDefinition number

Set the maximum number of object entries per object definition that can be created by a guest user. After reaching this limit, object entries created by a guest user will no longer be accepted.

Default: 100
timeScale string

Choose between days or weeks.

Default: "days"
Values: "days" "weeks"
77. Schedule object
pid const: "com.liferay.object.configuration.ObjectEntryScheduleConfiguration" required
Constant: "com.liferay.object.configuration.ObjectEntryScheduleConfiguration"
checkInterval number

Set the interval (in minutes) to check for expiration, publishing, and review of object entries.

Default: 15
78. Versioning for Entries object
maximumRetentionPeriod number required

Define the maximum retention period for entry versions. Once this period expires, the system will automatically delete the oldest versions to optimize storage space.

Default: 0
pid const: "com.liferay.object.configuration.ObjectEntryVersionConfiguration" required
Constant: "com.liferay.object.configuration.ObjectEntryVersionConfiguration"
maximumVersionsPerEntry number

Define the maximum number of entries to be stored per object. Once this limit is reached, the oldest versions will be automatically deleted to optimize storage space.

Default: 0
79. object object
pid const: "com.liferay.osb.patcher.configuration.PatcherConfiguration" required
Constant: "com.liferay.osb.patcher.configuration.PatcherConfiguration"
githubURL string
Default: ""
googleCloudHotfixBucket string
Default: ""
helpCenterURL string
Default: ""
hotfixMountPath string
Default: ""
infoModifyTicketsListURL string
Default: ""
jenkinsAdminUserName string
Default: ""
jenkinsAdminUserToken string
Default: ""
jenkinsBuildWithParametersPath string
Default: ""
jenkinsLoadBalancerBaseInvocationURL string
Default: ""
jenkinsLoadBalancerEnabled boolean
Default: false
jenkinsToken string
Default: ""
jenkinsURL string
Default: ""
jiraURL string
Default: ""
lesaURL string
Default: ""
liferayUsersProfileURL string
Default: ""
patcherAccountWhitelist string[]
Default: ""
patcherAgentJenkinsURL string
Default: ""
patcherBuildDownloadURL string
Default: ""
patcherGitTagPrefix string
Default: ""
patcherJenkinsRequestsEnabled boolean
Default: false
patcherLiferayPortalRepository string
Default: ""
patcherPubsubProjectId string
Default: ""
patcherPubsubSubscriptionId string
Default: ""
patcherScanningEnabled boolean
Default: false
patcherSharedRequestAddFixPatcherType string
Default: ""
patcherSharedRequestBuildPatchPatcherType string
Default: ""
patcherStatusBuildJenkinsPath string
Default: ""
patcherStatusBuildJenkinsTestPath string
Default: ""
patcherStatusBuildPath string
Default: ""
patcherStatusFixPath string
Default: ""
patcherStatusPath string
Default: ""
patcherTestsEnabled boolean
Default: false
supportLiferayAPIClientId string
Default: ""
supportLiferayAPIClientSecret string
Default: ""
supportLiferayAccountSearchAPIEndpoint string
Default: ""
supportLiferayLFUURL string
Default: ""
supportLiferayTicketAttachmentAPIEndpoint string
Default: ""
supportLiferayURL string
Default: ""
troubleshootingURL string
Default: ""
80. object object
pid const: "com.liferay.osb.patcher.configuration.PatcherEmailConfiguration" required
Constant: "com.liferay.osb.patcher.configuration.PatcherEmailConfiguration"
emailPatcherBuildCompleteBody object
emailPatcherBuildCompleteSubject object
emailPatcherBuildConflictBody object
emailPatcherBuildConflictSubject object
emailPatcherBuildFailedBody object
emailPatcherBuildFailedSubject object
emailPatcherBuildQAAnalysisNeededBody object
emailPatcherBuildQAAnalysisNeededSubject object
emailPatcherBuildQAAutomationPassedBody object
emailPatcherBuildQAAutomationPassedSubject object
emailPatcherBuildQAFailedManuallyBody object
emailPatcherBuildQAFailedManuallySubject object
emailPatcherBuildQAPassedManuallyBody object
emailPatcherBuildQAPassedManuallySubject object
emailPatcherBuildRebaseConflictBody object
emailPatcherBuildRebaseConflictSubject object
emailPatcherBuildTimeoutBody object
emailPatcherBuildTimeoutSubject object
emailPatcherFixCompleteBody object
emailPatcherFixCompleteSubject object
emailPatcherFixFailedBody object
emailPatcherFixFailedSubject object
emailPatcherFixTimeoutBody object
emailPatcherFixTimeoutSubject object
emailQAComments object
81. BCrypt Crypto Hash Provider Configuration object
configurationName string required

Set hash provider configuration name.

pid const: "com.liferay.portal.crypto.hash.provider.bcrypt.internal.configuration.BCryptCryptoHashProviderConfiguration" required
Constant: "com.liferay.portal.crypto.hash.provider.bcrypt.internal.configuration.BCryptCryptoHashProviderConfiguration"
rounds number

BCrypt Rounds

Default: 10
82. Message Digest Crypto Hash Provider Configuration object
configurationName string required

Set hash provider configuration name.

pid const: "com.liferay.portal.crypto.hash.provider.message.digest.internal.configuration.MessageDigestCryptoHashProviderConfiguration" required
Constant: "com.liferay.portal.crypto.hash.provider.message.digest.internal.configuration.MessageDigestCryptoHashProviderConfiguration"
algorithm string

Set message digest algorithm.

Default: "SHA-256"
saltSize number

Set message digest salt size.

Default: 32
83. Default Permissions Configuration object
pid const: "com.liferay.portal.defaultpermissions.configuration.PortalDefaultPermissionsCompanyConfiguration" required
Constant: "com.liferay.portal.defaultpermissions.configuration.PortalDefaultPermissionsCompanyConfiguration"
defaultPermissions string
84. Portal Cross-Origin Resource Sharing (CORS) object

Enables CORS for matching URLs in the portal.

pid const: "com.liferay.portal.remote.cors.configuration.PortalCORSConfiguration" required

Enables CORS for matching URLs in the portal.

Constant: "com.liferay.portal.remote.cors.configuration.PortalCORSConfiguration"
enabled boolean
Default: true
filterMappingURLPatterns string[]

Set URL pattern where CORS is enabled.

Default: "/api/jsonws/*|/documents/*|/image/*|/o/api/*|/o/graphql"
headers string[]

Set the headers to be sent in response to CORS requests in the form of "Name: Value".

Default: "Access-Control-Allow-Credentials: true|Access-Control-Allow-Headers: *|Access-Control-Allow-Methods: *|Access-Control-Allow-Origin: http://localhost:8080 http://127.0.0.1:8080 ::1"
name string

Identifies the configuration. The name is not used directly in the application.

85. Semantic Search object

Configure third party providers and other settings to index and search text embeddings. You can enable additional providers for Semantic Search in Instance Settings > Feature Flags > Beta.

pid const: "com.liferay.portal.search.configuration.SemanticSearchConfiguration" required

Configure third party providers and other settings to index and search text embeddings. You can enable additional providers for Semantic Search in Instance Settings > Feature Flags > Beta.

Constant: "com.liferay.portal.search.configuration.SemanticSearchConfiguration"
textEmbeddingCacheTimeout number
Default: 604800
textEmbeddingProviderConfigurationJSONs string[]
Default: ""
textEmbeddingsEnabled boolean
Default: false
86. Deep Pagination Configuration object
pid const: "com.liferay.portal.search.elasticsearch8.configuration.DeepPaginationConfiguration" required
Constant: "com.liferay.portal.search.elasticsearch8.configuration.DeepPaginationConfiguration"
enableDeepPagination boolean

Enable deep pagination to paginate through all the results of a search query.

Default: false
pointInTimeKeepAliveSeconds number

The amount of time in seconds the search engine will keep a point in time alive (between 1 and 60).

Default: 60
87. Analytics Cloud Search Site Activity object
pid const: "com.liferay.portal.search.internal.configuration.SiteActivityAsahConfiguration" required
Constant: "com.liferay.portal.search.internal.configuration.SiteActivityAsahConfiguration"
cacheTimeout number
Default: 14400
88. Analytics Cloud Search User Activity object
pid const: "com.liferay.portal.search.internal.configuration.UserActivityAsahConfiguration" required
Constant: "com.liferay.portal.search.internal.configuration.UserActivityAsahConfiguration"
cacheTimeout number
Default: 14400
89. Deep Pagination Configuration object
pid const: "com.liferay.portal.search.opensearch2.configuration.DeepPaginationConfiguration" required
Constant: "com.liferay.portal.search.opensearch2.configuration.DeepPaginationConfiguration"
enableDeepPagination boolean

Enable deep pagination to paginate through all the results of a search query.

Default: false
pointInTimeKeepAliveSeconds number

The amount of time in seconds the search engine will keep a point in time alive (between 1 and 60).

Default: 60
90. Search Suggestions object
pid const: "com.liferay.portal.search.rest.configuration.SearchSuggestionsCompanyConfiguration" required
Constant: "com.liferay.portal.search.rest.configuration.SearchSuggestionsCompanyConfiguration"
enableSuggestionsEndpoint boolean

Enable or disable the suggestions REST endpoint. When disabled, search bar suggestions are not available for this virtual instance.

Default: true
91. Auto Login Basic Authentication Header object
pid const: "com.liferay.portal.security.auto.login.internal.basic.auth.header.configuration.BasicAuthHeaderAutoLoginConfiguration" required
Constant: "com.liferay.portal.security.auto.login.internal.basic.auth.header.configuration.BasicAuthHeaderAutoLoginConfiguration"
enabled boolean
Default: false
92. Basic Authentication Protocol Support object
pid const: "com.liferay.portal.security.configuration.BasicAuthHeaderSupportConfiguration" required
Constant: "com.liferay.portal.security.configuration.BasicAuthHeaderSupportConfiguration"
enabled boolean
Default: true
93. IFrame Sanitizer object
pid const: "com.liferay.portal.security.iframe.sanitizer.configuration.IFrameConfiguration" required
Constant: "com.liferay.portal.security.iframe.sanitizer.configuration.IFrameConfiguration"
blacklist string[]
enabled boolean
Default: true
removeIFrameTags boolean
Default: false
sandboxAttributeValues string[]
Default: ""
whitelist string[]
Default: "com.liferay.fragment.model.FragmentEntry|com.liferay.journal.model.JournalArticle"
94. Authentication object
pid const: "com.liferay.portal.security.ldap.authenticator.configuration.LDAPAuthConfiguration" required
Constant: "com.liferay.portal.security.ldap.authenticator.configuration.LDAPAuthConfiguration"
companyId number
Default: 0
enabled boolean
Default: false
method string

Set either bind or password-compare for the LDAP authentication method. Bind is preferred by most vendors so that you do not have to worry about encryption strategies.

Default: "bind"
Values: "bind" "password-compare"
passwordEncryptionAlgorithm string

Set the password encryption to use for comparing passwords during import and to use for encrypting passwords during export. Comparing passwords during import will only be used when the property "LDAPAuthConfiguration.method" is set to password-compare. If the encryption is set to NONE, which is the default value, passwords are considered as plain text. The SHA-512 algorithm is currently unsupported.

Default: "NONE"
passwordPolicyEnabled boolean

Set this to true to use LDAP's password policy instead of the portal password policy. If set to true, it is possible that portal generated passwords will not match the LDAP policy. See the "passwords.regexptoolkit.*" properties for details on configuring RegExpToolkit in generating these passwords. Note that if this is enabled, the portal will not check for valid passwords, expired passwords, or users that are locked out. This is now handled by the LDAP server's password policy.

Default: false
required boolean
Default: false
95. Servers object
pid const: "com.liferay.portal.security.ldap.configuration.LDAPServerConfiguration" required
Constant: "com.liferay.portal.security.ldap.configuration.LDAPServerConfiguration"
authSearchFilter string

Enter the search filter that is used to test the validity of a user. The tokens @company_id@, @email_address@, @screen_name@, and @user_id@ are replaced at runtime with the correct values.

Default: "(mail=@email_address@)"
baseDN string

The Base DN specifies the initial search context for users and is optional.

Default: ""
baseProviderURL string
Default: "ldap://localhost:10389"
clockSkew number

The system time difference (in milliseconds) between the portal and the LDAP server. This is required for validating the user's modified timestamp during import.

Default: 3000
companyId number
Default: 0
contactCustomMappings string[]

When importing and exporting users, the portal will use this mapping to connect LDAP user attributes and portal contact's custom attributes.

Default: ""
contactMappings string[]

When importing and exporting users, the portal will use this mapping to connect LDAP user attributes and portal contact attributes.

Default: "birthday=|facebookSn=|jabberSn=|skypeSn=|smsSn=|twitterSn="
groupDefaultObjectClasses string[]

When a group is exported to LDAP and the group does not exist, the group will be created with the following default object classes.

Default: "top|groupOfUniqueNames"
groupMappings string[]

When importing groups, the portal will use this mapping to connect LDAP group attributes and portal user group attributes.

Default: "description=description|groupName=cn|user=uniqueMember"
groupSearchFilter string

Settings for importing groups from LDAP to the portal. These settings are not used unless the property "LDAPImportConfiguration.enabled" is set to true.

Default: "(objectClass=groupOfUniqueNames)"
groupSearchFilterEnabled boolean
Default: true
groupsDN string

New groups will be created at the specified DN. This will only be active if the property "LDAPAuthConfiguration.enabled" and "LDAPExportConfiguration.enabled" are set to true.

Default: ""
ignoreUserSearchFilterForAuth boolean

When checked, users do not need to match the LDAP server's search filter to authenticate.

Default: true
ldapServerId number
Default: 0
modifiedDate string
Default: ""
securityCredential string
Default: "secret"
securityPrincipal string
Default: ""
serverName string
Default: ""
userCustomMappings string[]

When importing and exporting users, the portal will use this mapping to connect LDAP user attributes and portal user's custom attributes.

Default: ""
userDefaultObjectClasses string[]

When a user is exported to LDAP and the user does not exist, the user will be created with the following default object classes.

Default: "top|person|inetOrgPerson|organizationalPerson"
userIgnoreAttributes string[]

Set the user attributes that are controlled from the portal. When adding or updating a user from LDAP, these attributes will be skipped.

Default: ""
userMappings string[]

When importing and exporting users, the portal will use this mapping to connect LDAP user attributes and portal user attributes.

Default: "emailAddress=mail|firstName=givenName|group=groupMembership|jobTitle=title|lastName=sn|password=userPassword|screenName=cn|uuid=uuid"
userSearchFilter string

Settings for importing users from LDAP to the portal. These settings are not used unless the property "LDAPImportConfiguration.enabled" is set to true.

Default: "(objectClass=inetOrgPerson)"
usersDN string

New users will be created at the specified DN. This will only be active if the property "LDAPAuthConfiguration.enabled" and "LDAPExportConfiguration.enabled" are set to true.

Default: ""
96. Connection object
pid const: "com.liferay.portal.security.ldap.configuration.SystemLDAPConfiguration" required
Constant: "com.liferay.portal.security.ldap.configuration.SystemLDAPConfiguration"
companyId number
Default: 0
connectionProperties string[]
Default: "com.sun.jndi.ldap.connect.pool=true|com.sun.jndi.ldap.connect.timeout=500|com.sun.jndi.ldap.read.timeout=15000"
errorPasswordExpiredKeywords string[]
Default: "expired"
errorPasswordHistoryKeywords string[]
Default: "history"
errorUserLockoutKeywords string[]
Default: "retry limit"
factoryInitial string
Default: "com.sun.jndi.ldap.LdapCtxFactory"
pageSize number

Set the page size for directory servers that support paging. This value needs to be 1000 or less for the Microsoft Active Directory Server.

Default: 1000
rangeSize number

Set the number of values to return in each query to a multivalued attribute for directory servers that support range retrieval. The range size must be 1000 or less for Windows 2000 and 1500 or less for Windows Server 2003.

Default: 1000
referral string
Default: "follow"
Values: "follow" "ignore" "throws"
97. Export object
pid const: "com.liferay.portal.security.ldap.exportimport.configuration.LDAPExportConfiguration" required
Constant: "com.liferay.portal.security.ldap.exportimport.configuration.LDAPExportConfiguration"
companyId number
Default: 0
exportEnabled boolean

Settings for exporting users from the portal to LDAP. This allows a user to modify his first name, last name, etc. in the portal and have that change pushed to the LDAP server. This setting is not used unless the property "LDAPAuthConfiguration.enabled" is set to true.

Default: false
exportGroupEnabled boolean

Set this to true if groups and their associations should be exported from the portal to LDAP. This setting is not used unless the property "LDAPAuthConfiguration.enabled" is set to true.

Default: true
98. Import object
pid const: "com.liferay.portal.security.ldap.exportimport.configuration.LDAPImportConfiguration" required
Constant: "com.liferay.portal.security.ldap.exportimport.configuration.LDAPImportConfiguration"
companyId number
Default: 0
importCreateRolePerGroup boolean

Set this to true if the portal should automatically create a role per group imported from LDAP. The role will be assigned to the group so that users can automatically inherit that role when they are assigned to the group.

Default: false
importEnabled boolean
Default: false
importGroupCacheEnabled boolean

Specify whether time-group DN lookups will be cached during LDAP import and login. If set to true, this will speed up LDAP import and login, but updates to group attributes will not be recognized until the cache entry expires. The cache size and timeout may be configured for the cache using the cache name "com.liferay.portal.security.exportimport.UserImporter".

Default: true
importInterval number
Default: 10
importLockExpirationTime number

Set the lock expiration time for LDAP import. By default, the expiration time is 1 day.

Default: 86400000
importMethod string

Set either user or group for import method. If set to user, the portal imports all users and the groups associated with those users. If set to group, the portal imports all groups and the users associated with those groups. This value should be set based on how your LDAP server stores group membership information.

Default: "user"
Values: "group" "user"
importOnStartup boolean
Default: false
importUserPasswordAutogenerated boolean
Default: false
importUserPasswordDefault string
Default: "test"
importUserPasswordEnabled boolean
Default: true
importUserSyncStrategy string
Default: "auth-type"
Values: "auth-type" "uuid"
99. OpenID Connect Provider Connection object
matcherField string required

The "sub" claim is the primary user matcher. If matching fails, the configured matcher field is used as a fallback.

Default: "email"
openIdConnectClientId string required

Set the client ID for the OpenID Connect provider.

Default: ""
openIdConnectClientSecret string required

Set the client secret for the OpenID Connect provider.

Default: ""
pid const: "com.liferay.portal.security.sso.openid.connect.internal.configuration.OpenIdConnectProviderConfiguration" required
Constant: "com.liferay.portal.security.sso.openid.connect.internal.configuration.OpenIdConnectProviderConfiguration"
providerName string required

Set the name for the OpenID Connect provider.

Default: ""
scopes string required

Set the scopes Liferay will request during authentication. Scopes are delimited with spaces.

Default: "openid email profile"
authorizationEndpoint string

Set the authorization endpoint for the OpenID Connect provider.

Default: ""
customAuthorizationRequestParameters string[]

Add custom authorization request parameters, e.g.: resource=https://contacts.google.com https://maps.google.com

Default: ""
customClaims string[]

Map the custom claims from the OpenId Connect provider to custom fields.

Default: ""
customTokenRequestParameters string[]

Add custom token request parameters, e.g.: resource=https://contacts.google.com https://maps.google.com

Default: ""
discoveryEndpoint string

Set the discovery endpoint for the OpenID Connect provider. If this is set, manually set endpoints will be ignored.

Default: ""
discoveryEndpointCacheInMillis number

Discovery endpoint metadata will be cached on this interval in milliseconds. If set to 0, Ehcache's default time to live value of 600 seconds will be used.

Default: 360000
idTokenSigningAlgValues string[]

Set the supported ID token signing algorithms for the OpenID Connect Provider. If the discovery endpoint is not specified, these algorithms are used. In this case, the algorithm RS256 must be included and must be the first algorithm in the list. If the discovery endpoint is specified, no algorithms should be specified here since the supported signing algorithms for the identity token are obtained from the discovery endpoint.

Default: "RS256"
issuerURL string

Set the issuer URL for the OpenID Connect provider.

Default: ""
jwksURI string

Set the JWKS URI for the OpenID Connect provider.

Default: ""
registeredIdTokenSigningAlg string

Set the ID token signing algorithm registered with the OpenId Connect provider. The default is RS256.

Default: ""
subjectTypes string[]

Set the subject types for the OpenID Connect provider.

Default: ""
tokenConnectionTimeout number

Set the amount of time to wait (in milliseconds) when establishing a connection to validate the token before timing out. A value of 0 means infinity and is not recommended.

Default: 1000
tokenEndpoint string

Set the token endpoint for the OpenID Connect provider.

Default: ""
userInfoEndpoint string

Set the user information endpoint for the OpenID Connect provider.

Default: ""
100. Headless API object
pid const: "com.liferay.portal.vulcan.internal.configuration.HeadlessAPICompanyConfiguration" required
Constant: "com.liferay.portal.vulcan.internal.configuration.HeadlessAPICompanyConfiguration"
pageSizeLimit number

Set the page size limit of elements that can be recovered through REST. Enter a negative number or zero for unlimited page size.

Default: 500
queryDepthLimit number

Set the query depth limit for GraphQL. Enter a negative number or zero for an unlimited query depth.

Default: 20
101. Headless API Endpoint object
path string required
Default: "/api"
pid const: "com.liferay.portal.vulcan.internal.configuration.VulcanCompanyConfiguration" required
Constant: "com.liferay.portal.vulcan.internal.configuration.VulcanCompanyConfiguration"
excludedOperationIds string
graphQLEnabled boolean
Default: true
restEnabled boolean
Default: true
102. Personal Menu object
pid const: "com.liferay.product.navigation.personal.menu.configuration.PersonalMenuConfiguration" required
Constant: "com.liferay.product.navigation.personal.menu.configuration.PersonalMenuConfiguration"
personalApplicationsLookAndFeel string

Define the look and feel for personal applications. Use the same look and feel of the current site or My Dashboard pages.

Default: "current-site"
Values: "current-site" "my-dashboard"
showInControlMenu boolean

Enable to always show the Personal Menu in the Control Menu. This guarantees users can always access the Personal Menu even if a theme does not provide it.

Default: false
showNotificationBadgeInPersonalMenu boolean

Enable to show the notification badge in the Personal Menu.

Default: true
103. Redirect URLs object

Configure which domains or IP addresses can be redirected to.

pid const: "com.liferay.redirect.internal.configuration.RedirectURLConfiguration" required

Configure which domains or IP addresses can be redirected to.

Constant: "com.liferay.redirect.internal.configuration.RedirectURLConfiguration"
allowedDomains string[]

Set the domains which the portal is allowed to redirect to. Remove all entries to allow any domain. Specifying a domain with a leading "*." allows redirects to subdomains. PORTAL_DOMAINS will be replaced with the current domain of the portal or site.

Default: "localhost|PORTAL_DOMAINS"
allowedIPs string[]

Set the IPs which the portal is allowed to redirect to. Remove all entries to allow any IP. SERVER_IP will be replaced with the IP of the host server.

Default: "127.0.0.1|SERVER_IP"
allowedProtocols string[]

Set which protocols are allowed in redirect URLs. Remove all entries to allow any protocol.

Default: "http|https"
securityMode string

If you are redirecting by domain, the portal will only redirect users to domains defined in the "Redirect URL Domains Allowed" fields. If you are redirecting by IP, the portal will only redirect to domains whose IP address resolves to an IP address defined in one of the "Redirect URL IPs Allowed" fields.

Default: "domain"
Values: "domain" "ip"
104. SAML Provider Configuration object
pid const: "com.liferay.saml.runtime.configuration.SamlProviderConfiguration" required
Constant: "com.liferay.saml.runtime.configuration.SamlProviderConfiguration"
allowShowingTheLoginPortlet boolean

Allow showing the login portlet when no SAML IdP is matched to the login request.

Default: true
assertionSignatureRequired boolean

Choose whether assertions must be signed by the IdP

authnRequestSignatureRequired boolean

Choose whether the IdP Authn requests from SPs must be signed.

Default: true
authnRequestSigningAllowsDynamicACSURL boolean

When the Authn request is signed, the service provider can request to use other ACS (Assertion Consumer Service) URLs not specified in the metadata for receiving the Authn response.

Default: true
clockSkew number

The system time difference (in milliseconds) between this SP and the IdP. Required for correct message validation.

Default: 3000
companyId number
Default: 0
defaultAssertionLifetime number

Defines how long IdP assertions last (in seconds). Used when configuring new SP connections.

Default: 1800
enabled boolean
entityId string

The local SAML entity's ID

keyStoreCredentialPassword string

Set the password used to protect the entry within the keystore.

Default: "liferay"
keyStoreEncryptionCredentialPassword string

Password used to protect the encryption entry within the keystore

Default: "liferay"
ldapImportEnabled boolean

After IdP authentication, import user attributes from the LDAP servers configured via This SP's instance settings

role string
sessionMaximumAge number

SSO session time limit managed by the IdP (in seconds)

sessionTimeout number

Time (in seconds) till idle session expires

signAuthnRequest boolean

Sign Authn Requests from This SP

Default: true
signMetadata boolean

Sign metadata provided to peer SAML entities

Default: true
sslRequired boolean

Require SAML messages to be exchanged over SSL. URLs in the metadata provided to peer SAML entities become https.

105. Ipstack object
pid const: "com.liferay.search.experiences.internal.configuration.IpstackConfiguration" required
Constant: "com.liferay.search.experiences.internal.configuration.IpstackConfiguration"
apiKey string
Default: ""
apiURL string
Default: "http://api.ipstack.com"
cacheTimeout number
Default: 604800
enabled boolean
Default: false
106. OpenWeatherMap object
pid const: "com.liferay.search.experiences.internal.configuration.OpenWeatherMapConfiguration" required
Constant: "com.liferay.search.experiences.internal.configuration.OpenWeatherMapConfiguration"
apiKey string
Default: ""
apiURL string
Default: "http://api.openweathermap.org/data/2.5/weather"
cacheTimeout number
Default: 604800
enabled boolean
Default: false
units string
Default: "metric"
Values: "imperial" "metric" "standard"
107. Analytics Cloud Segments object
pid const: "com.liferay.segments.asah.connector.internal.configuration.SegmentsAsahCompanyConfiguration" required
Constant: "com.liferay.segments.asah.connector.internal.configuration.SegmentsAsahCompanyConfiguration"
anonymousUserSegmentsCacheExpirationTime number

Define the time (in seconds) before clearing the Anonymous Segment cache.

Default: 86400
interestTermsCacheExpirationTime number

Define the time (in seconds) before clearing the Interest Terms cache.

Default: 86400
108. Segments Service object
pid const: "com.liferay.segments.configuration.SegmentsCompanyConfiguration" required
Constant: "com.liferay.segments.configuration.SegmentsCompanyConfiguration"
roleSegmentationEnabled boolean

When checked, this option allows assigning roles to users dynamically.

Default: false
segmentationEnabled boolean

Disable this option to prevent user segmentation on every request. If disabled, collections and experiences personalization will not be available.

Default: true
109. Session Property Vocabularies object

Link a session property to a vocabulary.

assetVocabularyName string required
entityFieldName string required
pid const: "com.liferay.segments.context.vocabulary.internal.configuration.SegmentsContextVocabularyCompanyConfiguration" required

Link a session property to a vocabulary.

Constant: "com.liferay.segments.context.vocabulary.internal.configuration.SegmentsContextVocabularyCompanyConfiguration"
110. Sharepoint OAuth2 object
pid const: "com.liferay.sharepoint.rest.repository.internal.configuration.SharepointRepositoryConfiguration" required
Constant: "com.liferay.sharepoint.rest.repository.internal.configuration.SharepointRepositoryConfiguration"
clientId string
clientSecret string
name string
scope string
tenantId string
111. Sharing object
pid const: "com.liferay.sharing.internal.configuration.SharingCompanyConfiguration" required
Constant: "com.liferay.sharing.internal.configuration.SharingCompanyConfiguration"
enabled boolean
Default: true
112. Bulk Action Task Configuration object
pid const: "com.liferay.site.cms.site.initializer.configuration.BulkActionTaskConfiguration" required
Constant: "com.liferay.site.cms.site.initializer.configuration.BulkActionTaskConfiguration"
checkInterval number

Set the check interval in minutes.

Default: 15
113. XML Sitemap object
pid const: "com.liferay.site.internal.configuration.SitemapCompanyConfiguration" required
Constant: "com.liferay.site.internal.configuration.SitemapCompanyConfiguration"
companySitemapGroupIds string[]
Default: ""
companySitemapObjectDefinitionIds string[]
Default: ""
includeCategories boolean
Default: true
includePages boolean
Default: true
includeWebContent boolean
Default: true
xmlSitemapIndexEnabled boolean
Default: true
114. Social Activity object
pid const: "com.liferay.social.activity.internal.configuration.SocialActivityCompanyConfiguration" required
Constant: "com.liferay.social.activity.internal.configuration.SocialActivityCompanyConfiguration"
enableUserSocialActivityTracking boolean
Default: true
115. Staging object

The settings in this configuration let you control the staging process.

pid const: "com.liferay.staging.configuration.StagingConfiguration" required

The settings in this configuration let you control the staging process.

Constant: "com.liferay.staging.configuration.StagingConfiguration"
stagingDeleteTempLAROnFailure boolean

Uncheck to avoid deleting the temporary LAR during a failed staging publish process. In remote staging contexts, this only applies for the staging environment.

Default: true
stagingDeleteTempLAROnSuccess boolean

Uncheck to avoid deleting the temporary LAR during a successful staging publish process. In remote staging contexts, this only applies for the staging environment.

Default: true
stagingUseVirtualHostForRemoteSite boolean

The remote environment's virtual host is used when accessing the remote live site from the staged site.

Default: false
116. Translator Using Amazon Translate object
pid const: "com.liferay.translation.translator.aws.internal.configuration.AWSTranslatorConfiguration" required
Constant: "com.liferay.translation.translator.aws.internal.configuration.AWSTranslatorConfiguration"
accessKey string
Default: ""
enabled boolean

Enable or disable the integration with Amazon Translate API for automatic translations.

Default: false
region string
Default: "us-west-1"
secretKey string
Default: ""
117. Translator Using Microsoft Translate object
pid const: "com.liferay.translation.translator.azure.internal.configuration.AzureTranslatorConfiguration" required
Constant: "com.liferay.translation.translator.azure.internal.configuration.AzureTranslatorConfiguration"
enabled boolean

Enable or disable the integration with Microsoft Translate API for automatic translations.

Default: false
resourceLocation string
Default: ""
subscriptionKey string
Default: ""
118. Translator Using DeepL Translate object
pid const: "com.liferay.translation.translator.deepl.internal.configuration.DeepLTranslatorConfiguration" required
Constant: "com.liferay.translation.translator.deepl.internal.configuration.DeepLTranslatorConfiguration"
authKey string
enabled boolean

Enable or disable the integration with DeepL Translate API for automatic translations.

Default: false
url string
Default: "https://api-free.deepl.com/v2/translate"
validateLanguageURL string
Default: "https://api-free.deepl.com/v2/languages"
119. Translator Using Google Cloud object
pid const: "com.liferay.translation.translator.google.cloud.internal.configuration.GoogleCloudTranslatorConfiguration" required
Constant: "com.liferay.translation.translator.google.cloud.internal.configuration.GoogleCloudTranslatorConfiguration"
enabled boolean

Enable or disable the integration with Google Cloud Translation API for automatic translations.

Default: false
serviceAccountPrivateKey string

Specify the service account private key in JSON format.

Default: ""
120. Anonymous User object
pid const: "com.liferay.user.associated.data.web.internal.configuration.AnonymousUserConfiguration" required
Constant: "com.liferay.user.associated.data.web.internal.configuration.AnonymousUserConfiguration"
userId number

The user ID of the user designated as the anonymous user. This user will be used to replace a given user's data when an anonymization operation is requested.

Default: 0
121. User Images object
pid const: "com.liferay.users.admin.configuration.UserFileUploadsConfiguration" required
Constant: "com.liferay.users.admin.configuration.UserFileUploadsConfiguration"
imageCheckToken boolean

Enable to check the image token for user portraits and organization logos before displaying them.

Default: true
imageDefaultUseInitials boolean

Enable to set the user's initials as the default user portrait. Otherwise, the default portrait image files will be used. The default portrait image path is set by the "image.default.user.portrait" property in portal.properties.

Default: true
imageMaxHeight number

Set the maximum user portrait height in pixels. A value of 0 indicates no restrictions on user portrait dimensions.

Default: 290
imageMaxSize number

Set the maximum file size in bytes for user portraits. A value of 0 indicates no limit. Regardless of the value entered here, uploaded files cannot exceed the "Max Size" set in System Settings > Infrastructure > Upload Servlet Request.

Default: 307200
imageMaxWidth number

Set the maximum user portrait width in pixels. A value of 0 indicates no restrictions on user portrait dimensions.

Default: 290