---
title: Session Attribute Map
description: Map the value of a specified session attribute to one or more HTTP headers or HTTP cookies, depending on the value of Session Attribute Fetch Mode.
component: web-agents
version: 2025.11
page_id: web-agents:properties-reference:com.sun.identity.agents.config.session.attribute.mapping
canonical_url: https://docs.pingidentity.com/web-agents/2025.11/properties-reference/com.sun.identity.agents.config.session.attribute.mapping.html
---

# Session Attribute Map

Map the value of a specified session attribute to one or more HTTP headers or HTTP cookies, depending on the value of [Session Attribute Fetch Mode](com.sun.identity.agents.config.session.attribute.fetch.mode.html).

* Map key: The name of an existing session attribute for the currently authenticated user.

* Map value: The name of one or more HTTP headers or HTTP cookies.

If the HTTP header or HTTP cookie name does not exist, the agent creates it. If the session attribute name (key) does not exist, the agent does not create the HTTP header or HTTP cookie.

|   |                                                                                                                                                                                                        |
| - | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|   | Underscores in header names can cause errors in some web containers. Either don't use underscores in header names, or see your web container documentation for information about how they are managed. |

When an HTTP header name is used in a request header, it is prefixed by `HTTP_`. The agents automatically changes lower case letters to upper case, and hyphens (`-`) to underscores (`_`). For example, `CUSTOM-userid` becomes `HTTP_CUSTOM-USERID`.

Format:

`com.sun.identity.agents.config.session.attribute.mapping[session_attribute]=ATTR1|ATTR2`

Examples:

The following example maps the value of the session attribute `UserToken` to the HTTP header `CUSTOM-userid`:

`com.sun.identity.agents.config.session.attribute.mapping[UserToken]=CUSTOM-userid`.

The following example maps the value of the session attribute `UserId` to two HTTP headers:

`` com.sun.identity.agents.config.session.attribute.mapping[UserId]=HEADER1|HEADER2` ``.

Default: Empty

|                    |                                                                                          |
| ------------------ | ---------------------------------------------------------------------------------------- |
| Property name      | `com.sun.identity.agents.config.session.attribute.mapping`   Introduced in Web Agent 4.x |
| Function           | Attribute processing                                                                     |
| Type               | String Map                                                                               |
| Bootstrap property | No                                                                                       |
| Required property  | No                                                                                       |
| Restart required   | No                                                                                       |
| AM console         | Tab: `Application`Title: `Session Attribute Map`                                         |