Web Policy Agents 5.10.1

Response Attribute Map

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

  • Map key: The name of a response attribute returned by AM with a policy decision.

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

Consider the following points for 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, the agent recreates it.

  • If an unauthenticated user attempts to access the protected page, the agent deletes HTTP cookies with the mapped name on the first request, and then creates them after login.

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

Consider the following points for response headers:

  • If a response header with the mapped name does not exist, the agent creates it.

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

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

  • 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.

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

Default: Empty

Property name

com.sun.identity.agents.config.response.attribute.mapping
  Introduced in Web Agent 4.x

Type

String Map

Bootstrap property

No

Required property

No

Restart required

No

AM console

Tab: Application

Title: Response Attribute Map

Copyright © 2010-2022 ForgeRock, all rights reserved.