How To
ForgeRock Identity Platform
Does not apply to Identity Cloud

How do I modify the prompt text shown when authenticating to a tree in AM 5.5.x, 6.x and 7.x?

Last updated Oct 13, 2021

The purpose of this article is to provide assistance if you want to customize the prompt text displayed when authenticating to a tree. This article focuses on changing the User Name and Password prompts.


Background information

Collector nodes provide a callback mechanism where input is collected. A typical example is the username collector, which provides a single text-based callback.

The two main collectors of interest when customizing the login process are the Username Collector Node and the Password Collector Node; each of the collector nodes has a corresponding properties file, which contains the callback.[name] property. This property defines the prompt text.

The collector nodes' property files are located in the auth-nodes-<version>.jar file in the WEB-INF/lib directory of the AM WAR file. You can find these files in the following path within the jar file: org/forgerock/openam/auth/nodes.

Modifying the prompt text

The following example demonstrates changing the user name and password prompts:

  1. Unpack the AM WAR file and extract the auth-nodes-<version>.jar file from the WEB-INF/lib directory.
  2. Navigate to the org/forgerock/openam/auth/nodes path within the extracted jar.
  3. Edit the UsernameCollectorNode.properties file to update the callback.username property to the prompt of your choice, for example: callback.username=Your User Name
  4. Edit the PasswordCollectorNode.properties file to update the callback.password property to the prompt of your choice, for example: callback.password=Your Password
  5. Repack the auth-nodes-<version>.jar with your changes.
  6. Add your customization to the AM WAR file:
    • Replace the existing jar file in the WEB-INF/lib directory with your customized jar file.
    • Repack the AM WAR file and deploy as normal.
  7. Restart the web application container in which AM runs.
  8. Test your changes.

The resulting login page looks like this after a restart:

Followed by the Password Collector Node:

See Also

How do I customize authentication tree nodes using source code in AM 5.5.x and 6?

Authentication Node Development Guide

Related Training

N/A

Related Issue Tracker IDs

OPENAM-14467 (RFE: Ability to customise Authentication Tree's)

OPENAM-12978 (API Explorer - Create Page Node Example Value is inadequate)


Copyright and Trademarks Copyright © 2021 ForgeRock, all rights reserved.