Java Agents 5.10.3

Logout Request Parameter Map

A map of request parameters that trigger logout of the user session. Use the following key:value format:

`web application name:parameter name to trigger logout

The agent searches every incoming request for the parameter. When the agent detects the parameter, it invokes AM to kill the current session for the specified web application or all web applications.

The request URL must contain the parameter, but does not need to assign a value to the parameter.

Although logout can be triggered within any web application by invoking a single, common, URI, you can taylor it for particular web applications:

  • To specify a single, common, URI, leave the key empty.

  • To specify a URI unique to a particular web application, specify the name of the web application as the key.

Property name

org.forgerock.agents.logout.request.param.map

Aliases

org.forgerock.agents.logout.request.param.map
  Introduced in Java Agent 5.6

com.sun.identity.agents.config.logout.request.param
  Introduced in Java Agent 5.0
  Recognized from AM 6

Function

Logout

Type

Map

  • Keys: web application

  • Values: (single) HTTP query parameter to trigger logout

Bootstrap property

No

Required property

No

Restart required

No

Local configuration file

AgentConfig.properties

AM console

Tab: Application

Title: Logout Request Parameter Map

Legacy title: Logout Request Parameter

Copyright © 2010-2024 ForgeRock, all rights reserved.