Legacy Knowledge Base
Published Jul. 2, 2025

How to configure the "check-auth-token" parameter within an OSGi portlet?

Written By

Nathan Roberts

How To articles are not official guidelines or officially supporteddocumentation. They are community-contributed content and may not alwaysreflect the latest updates to Liferay DXP. We welcome your feedback toimprove How to articles!

While we make every effort to ensure this Knowledge Base is accurate, itmay not always reflect the most recent updates or official guidelines.We appreciate your understanding and encourage you to reach out with anyfeedback or concerns.

Legacy Article

You are viewing an article from our legacy "FastTrack"publication program, made available for informational purposes. Articlesin this program were published without a requirement for independentediting or verification and are provided "as is" withoutguarantee.

Before using any information from this article, independently verify itssuitability for your situation and project.

Issue

The current Liferay DXP portal properties file contains the following for the "check-auth-token" parameter:

    #
    # Set this to true to enable authentication token security checks. The
    # checks can be disabled for specific actions via the property
    # "auth.token.ignore.actions" or for specific portlets via the init
    # parameter "check-auth-token" in portlet.xml.
    #
    auth.token.check.enabled=true

As OSGi portlets lack a portlet.xml file the "check-auth-token" parameter can not be used.

Environment

  • Liferay DXP 7.0
  • Liferay DXP 7.1
  • Liferay DXP 7.2

Resolution

To disable the check for a specific portlet, the following property can be set within the @Component annotation of the corresponding portlet class:

@Component(
property = {
javax.portlet.init-param.check-auth-token=false,
// Other properties
},
service = Portlet.class
)
public class MyPortletClass { ... }

Additional Information

Did this article resolve your issue ?

Legacy Knowledge Base