Java Agents 2024.11

Logout URI Map

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

web application name:logout URI

When a URL that includes the specified URI is invoked, the agent kills the current session. It invokes the AM REST logout endpoint or the endpoint configured by Conditional Logout URL List.

The agent must be able to access the context for the URL. When a web application is specified, it must exist and the agent must have access to it.

The URL is a dummy URL. Even if a resource exists at the URL, it is never accessed.

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.endpoint.map

Aliases

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

org.forgerock.agents.logout.endpoint.map
  Introduced in Java Agent 5.6

Function

Logout

Type

Map

  • Keys: web application

  • Values: URI of dummy endpoint which will trigger logout

Bootstrap property

No

Required property

No

Restart required

No

Local configuration file

AgentConfig.properties

AM console

Tab: Application

Title: Logout URI Map

Legacy title: Application Logout URI

Copyright © 2010-2024 ForgeRock, all rights reserved.