User Mapping Mode

Specifies where to obtain the user ID

Property name

org.forgerock.agents.user.mapping.mode

Property aliases

org.forgerock.agents.user.mapping.mode (since 5.6)

com.sun.identity.agents.config.user.mapping.mode (since 5.0)

Supported settings

USER_ID

If "Enable User Principal Flag" (org.forgerock.agents.userid.mapping.mode.use.dn.enabled) is true, the user ID is set from the User Principal. Otherwise, the user ID is set from the user’s session property nominated by "User Session Name" (org.forgerock.agents.userid.mapping.mode.use.session.property.name).

PROFILE_ATTRIBUTE

The user ID is set to the value of a named profile attribute specified by "User Attribute Name" (org.forgerock.agents.user.mapping.mode.attribute.name).

HTTP_HEADER

The user ID is set to the value of the HTTP header specified by the "User Attribute Name" (org.forgerock.agents.user.mapping.mode.attribute.name).

SESSION_PROPERTY

The user ID is set to the value of the session property specified by the "User Attribute Name" (org.forgerock.agents.user.mapping.mode.attribute.name).

Default

USER_ID

Bootstrap property

No

Required property

No

Restart required

No

Local configuration file

AgentConfig.properties

AM console tab

Global