Java Agents 2024.6

JWT Cookie Name

The name of the cookie that holds the OIDC JWT on the user’s browser.

Before changing the name of this cookie, consider the following points:

  • This cookie is only used by the agent and is never presented to AM.

  • The cookie name must be unique in the cookies the user’s browser receives. For example, do not set the JWT cookie name to iPlanetDirectoryPro, which is the default name of the AM session cookie.

If the agent does not find the cookie named by JWT Cookie Name, authentication fails. The user can only access resources that are available through not-enforced rules.

Property name

org.forgerock.agents.jwt.cookie.name

Aliases

org.forgerock.openam.agents.config.jwt.name
  Introduced in Java Agent 5.0
  Recognized from AM 6

org.forgerock.agents.jwt.cookie.name
  Introduced in Java Agent 5.6

Function

Profile

Type

String

Default

am-auth-jwt

Bootstrap property

Yes

Required property

No

Restart required

No

Local configuration file

AgentBootstrap.properties

AM console

Tab: Global

Title: JWT Cookie Name

Copyright © 2010-2024 ForgeRock, all rights reserved.