Auth node reference

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";
}

Outcomes

Single outcome path.

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 nodeState object used to store the retrieved value.

Example

Scripted node to check for a session at the start of the flow
Figure 1. Access Management
Scripted node to check for a session at the start of the flow
Figure 2. Ping Identity Platform

The following table includes example keys that may be available in an existing session and the corresponding sample values:

Key Sample value

AMCtxId

e370cca2-02d6-41f9-a244-2b107206bd2a-122934

amlbcookie

01

authInstant

2023-04-04T09:19:05Z

AuthLevel

0

CharSet

UTF-8

clientType

genericHTML

FullLoginURL

/am/XUI/?realm=alpha#login/

Host

34.117.172.39

HostName

am.forgeblocks.com

Locale

en_US

Organization

dc=openam,dc=forgerock,dc=org

Principal

uid=amAdmin,ou=People,dc=openam,dc=forgerock,dc=org

Principals

amAdmin

Service

ldapService

successURL

/openam/console

sun.am.UniversalIdentifier

uid=amAdmin,ou=People,dc=openam,dc=forgerock,dc=org

UserId

amAdmin

UserProfile

Required

UserToken

amAdmin

webhooks

myWebHook