How To
ForgeRock Identity Platform
Does not apply to Identity Cloud

How do I change the persistent cookie name (session-jwt) in AM (All versions)?

Last updated May 10, 2022

The purpose of this article is to provide information on changing the persistent cookie name in AM. The persistent cookie is called session-jwt by default and is created via the Persistent Cookie module.


Overview

The property that relates to the persistent cookie name (openam-auth-persistent-cookie-name) is not exposed via the console or ssoadm by default in pre-AM 5.5. However, in those releases you can still change it via the console.

The following sections detail how to change the persistent cookie name depending on which version you are using:

Changing the persistent cookie name (AM 5.5 and later)

You can change the name of the persistent cookie as follows using either the console, Amster or ssoadm:

  • Console: navigate to: Realms > [Realm Name] > Authentication > Modules > Persistent Cookie Module > Persistent Cookie Name and enter the new cookie name.
  • Amster: follow the steps in How do I update property values in AM (All versions) using Amster? with these values:
    • Entity: PersistentCookieModule
    • Property: cookieName
  • ssoadm: enter the following command: $ ./ssoadm update-auth-instance -e [realmname] -m [modulename] -u [adminID] -f [passwordfile] -a openam-auth-persistent-cookie-name=[name]replacing [realmname], [modulename], [adminID], [passwordfile] and [name] with appropriate values.

Changing the persistent cookie name (AM 5 and 5.1.x)

You can change the name of the persistent cookie in the console as follows:

  1. Navigate to Realms > [Realm Name] > Authentication > Chains > [Chain Name] and click the pencil icon against the Persistent Cookie module to edit the module properties.
  2. Enter the following Key and Value under Options: KEY VALUE openam-auth-persistent-cookie-name newNamewhere newName is the new name for the persistent cookie.

See Also

How do I change the session cookie name for AM and Agents (All versions)?

FAQ: Cookies in AM

Persistent cookie is not created in AM (All versions) after changing default keystore

Persistent cookie is no longer created in AM (All versions)

Session quotas not limiting active user sessions in AM (All versions) when persistent cookies are used

Authentication modules in AM

Persistent Cookie Module

Related Training

N/A

Related Issue Tracker IDs

N/A


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