Session Attribute Map

Session Attribute Mapping

Maps a session attribute to one or more HTTP headers for the currently authenticated user. The map key is an attribute name, and the map values are HTTP header names. Separate multiple map values with a pipe (|) character.

The session attribute is the attribute in the session to be fetched.

To populate the value of session attribute UserToken under CUSTOM-userid, enter UserToken in the Map Key field, and enter CUSTOM-userid in the Corresponding Map Value field. This corresponds to org.forgerock.agents.session.attribute.map[UserToken]=CUSTOM-userid.

In most cases, in a destination web application where an HTTP header name shows up as a request header, it is prefixed by HTTP_, lower case letters become upper case, and hyphens (-) become underscores (_). For example, success-url becomes HTTP_SUCCESS_URL.

Format: session attribute = HEADER_NAME(S)

Example: [UserToken]=HEADER1|HEADER2

Property name

org.forgerock.agents.session.attribute.map

Property aliases

org.forgerock.agents.session.attribute.map (since 5.6)

com.sun.identity.agents.config.session.attribute.mapping (since 5.0)

Type

Map

  • Keys: source session attribute name

  • Values: one or more target session attribute names

Bootstrap property

No

Required property

No

Restart required

No

Local configuration file

AgentConfig.properties

AM console tab

Application