Web Agents 2023.11.1

Profile Attribute Map

Map the value of a specified profile attribute to one or more HTTP headers or HTTP cookies, depending on the value of Profile Attribute Fetch Mode.

  • Map key: The name of an existing profile 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 profile 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.

To populate the value of profile attribute CN under CUSTOM-Common-Name, configure com.sun.identity.agents.config.profile.attribute.mapping[CN]=CUSTOM-Common-Name.

Make sure the case of your LDAP attribute name matches the case of the LDAP schema, otherwise you may see an error similar to the following: do_header_set(): SM_LOGIN (UiD) is not available in profile attributes

In most cases, in a destination 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, CUSTOM-userid becomes HTTP_CUSTOM-USERID.

Format: profile attribute = HEADER-NAME(S)

Example: [CN]=HEADER1|HEADER2

Default: Empty

Property name

com.sun.identity.agents.config.profile.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: Profile Attribute Map

Copyright © 2010-2024 ForgeRock, all rights reserved.