Response Attribute Map
Map the value of a response attribute specified in AM to one or more HTTP headers, HTTP cookies, or request attributes, 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, HTTP cookies, or request attributes
Consider the following points for response 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 response 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 HTTP 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
becomesHTTP_CUSTOM_USERID
.
Format: response attribute = HEADER-NAME(S)
, response attribute = COOKIE-NAME(S)
, response 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: [uid]=HEADER1|HEADER2
Property name |
|
Aliases |
|
Function |
Response |
Type |
Map
|
Bootstrap property |
No |
Required property |
No |
Restart required |
No |
Local configuration file |
|
AM console |
Tab: Title: Legacy title: |