---
title: Authentication Fail Reason Parameter Name
description: A query parameter name to contain the reason why authentication failed. The agent appends this parameter to the URL or URI defined by Authentication Fail URL.
component: java-agents
version: 2025.11
page_id: java-agents:properties-reference:org.forgerock.agents.authn.fail.reason.parameter.name
canonical_url: https://docs.pingidentity.com/java-agents/2025.11/properties-reference/org.forgerock.agents.authn.fail.reason.parameter.name.html
---

# Authentication Fail Reason Parameter Name

A query parameter name to contain the reason why authentication failed. The agent appends this parameter to the URL or URI defined by [Authentication Fail URL](org.forgerock.agents.authn.fail.url.html).

If this property is not set, the agent does not append the reason for the authentication failure, when redirecting to the URL or URI.

To reduce the risk of leaking useful information, configure [Authentication Fail Reason Parameter Value Map](org.forgerock.agents.authn.fail.reason.remapper.html) to change the strings for the above values.

|                          |                                                                                                                                                               |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Property name            | `org.forgerock.agents.authn.fail.reason.parameter.name`                                                                                                       |
| Aliases                  | `org.forgerock.agents.authn.fail.reason.parameter.name`   Introduced in Java Agent 5.7   [Recognized](preface.html#how_am_manages_multiple_aliases) from AM 7 |
| Function                 | Authentication failure                                                                                                                                        |
| Type                     | String                                                                                                                                                        |
| Bootstrap property       | No                                                                                                                                                            |
| Required property        | No                                                                                                                                                            |
| Restart required         | No                                                                                                                                                            |
| Local configuration file | `AgentConfig.properties`                                                                                                                                      |
| AM console               | Tab: `Miscellaneous (from AM 7)`Title: `Authentication Fail Reason Parameter Name`                                                                            |