Banner message for Policy Manager

Products

• CA API Gateway

Issue/Introduction

Requirement to display a Banner message when accessing gateway from policy manager 

Environment

Gateway 10.1 CR1+ Gateway 11

Resolution

There are two clusterwide properties that can be used to send message to the user when policy manager authentication occurs

Docs link 

https://techdocs.broadcom.com/us/en/ca-enterprise-software/layer7-api-management/api-gateway/11-0/reference/gateway-cluster-properties/administrative-account-cluster-properties.html

Clusterwide properties warning message and a prelogin message 

logon.warningBanner

The warning message that is displayed to the user after logging in to the Policy Manager. The user must accept this warning to continue or be disconnected.

Default: blank (no warning banner is displayed)

Warning message after successful login - MUST be accepted to access Policy Manager

 

policyManager.preloginWarning

Applicable to Gateway version 10.1 CR1+

 

Applies to users seeking to comply with the Common Criteria framework and are required to display a security-administrator advisory notice and consent warning message regarding unauthorized use of the Gateway prior to logging into the Policy Manager. To enable the warning message and to insert your custom message, enter a simple text string as a value. For 

example:

policyManager.preloginWarning = Warning! You must have admin access to use the Policy Manager!

Default: None

Disabling the Prelogin Warning Message

If you decide to disable the warning message after configuring the cluster property, you must set the value to 'DISABLED' or remove the cluster property entirely.

 

In the event that the system property equivalent, 'com.l7tech.server.policyManager.preloginWarning' is configured, recall that the system property shall always override the cluster property equivalent, even if disabled.

Message to be displayed before the User Name and password are sent -  MUST accept for the authentication to occur