Get Session Data node
Retrieves the value of a specified key from a user’s session data,
and stores it in the specified key in the shared nodeState object.
This node is only used during session upgrade—when the user has already successfully authenticated previously—and is now upgrading their session for additional access. For more information on upgrading a session, refer to Session upgrade.
This node fails with an error if you attempt to get a property when the user does not have an existing session. Use a Scripted Decision node with a script that determines if an existing session is present:
if (typeof existingSession !== 'undefined') {
outcome = "hasSession";
} else {
outcome = "noSession";
}Compatibility
| Product | Compatible? |
|---|---|
ForgeRock Identity Cloud |
|
ForgeRock Access Management (self-managed) |
|
ForgeRock Identity Platform (self-managed) |
Properties
| Property | Usage |
|---|---|
Session Data Key (required) |
Specify the name of a key in the user’s session data used to retrieve the value. |
Shared State Key (required) |
Specify the name of a key in the |
Example
The following table includes example keys that may be available in an existing session and the corresponding sample values:
| Key | Sample value |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|