Java Policy Agents 5.10.2

Profile Attribute Map

Map the value of an AM profile attribute to one or more HTTP headers, HTTP cookies, or request attributes, depending on the value of Profile Attribute Fetch Mode.

  • Map key: The name of an AM profile attribute

  • Map value: The name of one or more HTTP headers, HTTP cookies, or request attributes

The user profile can be stored in LDAP or any other arbitrary data store

Consider the following points for HTTP cookies:

  • If an HTTP cookie with the mapped name does not exist, the agent creates it.

  • If an HTTP cookie with the mapped name already exists and the cookie value is different from the mapped value, the agent overwrites the cookie.

  • If an HTTP cookie with the mapped name already exists and the cookie value is the same as the mapped value, the agent does nothing.

  • If the profile attribute name (key) does not exist, the agent does not create the HTTP cookie.

  • The agent does not automatically clear cookies. To prevent a build up of cookies, consider adding them to the Reset Cookie List.

Consider the following points for HTTP headers:

  • If an HTTP header with the mapped name does not exist, the agent creates it.

  • If an HTTP header with the mapped name already exists, the agent does not overwrite it but simply appends information to the header.

  • If the profile attribute name (key) does not exist, the agent does not create the HTTP header.

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

Format: profile attribute = HEADER-NAME(S), profile attribute = COOKIE-NAME(S), profile attribute = REQUEST-ATTRIBUTE(S)

Default: Empty

Examples:

In the following example, the AM response attribute uid is mapped to CUSTOM-User-Name: com.sun.identity.agents.config.response.attribute.mapping[uid]=Custom-User-Name

Example: [cn]=HEADER-1|HEADER-2

Property name

org.forgerock.agents.profile.attribute.map

Aliases

com.sun.identity.agents.config.profile.attribute.mapping
  Introduced in Java Agent 5.0
  Recognized from AM 6

org.forgerock.agents.profile.attribute.map
  Introduced in Java Agent 5.6

Type

Map

  • Keys: source response profile name

  • Values: one or more target response profile names

Bootstrap property

No

Required property

No

Restart required

No

Local configuration file

AgentConfig.properties

AM console

Tab: Application

Title: Profile Attribute Map

Legacy title: Profile Attribute Mapping

Copyright © 2010-2023 ForgeRock, all rights reserved.