responseCookie

Property Manager name: Set Response Cookie
Behavior version: The v2024-10-21 rule format supports the responseCookie behavior v1.3.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: Yes

Set a cookie to send downstream to the client with either a fixed value or a unique stamp.

Option	Type	Description	Requires
`cookieName`	string (allows variables)	Specifies the name of the cookie, which serves as a key to determine if the cookie is set.		{"displayType":"string","tag":"input","type":"text"}
`enabled`	boolean	Allows you to set a response cookie.		{"displayType":"boolean","tag":"input","type":"checkbox"}
`type`	enum	What type of value to assign.		{"displayType":"enum","options":["FIXED","UNIQUE"],"tag":"select"} {"if":{"attribute":"enabled","op":"eq","value":true}}
	`FIXED`	Assign a `FIXED` value based on the `value` field.
	`UNIQUE`	Assign a unique value.
`value`	string (allows variables)	If the cookie `type` is `FIXED`, this specifies the cookie value.	`type` is `FIXED`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"type","op":"eq","value":"FIXED"}}
`format`	enum	When the `type` of cookie is set to `UNIQUE`, this sets the date format.	`type` is `UNIQUE`	{"displayType":"enum","options":["AKAMAI","APACHE"],"tag":"select"} {"if":{"attribute":"type","op":"eq","value":"UNIQUE"}}
	`AKAMAI`	Akamai format, which adds milliseconds to the date stamp.
	`APACHE`	Apache format.
`defaultDomain`	boolean	When enabled, uses the default domain value, otherwise the set specified in the `domain` field.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`defaultPath`	boolean	When enabled, uses the default path value, otherwise the set specified in the `path` field.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`domain`	string (allows variables)	If the `defaultDomain` is disabled, this sets the domain for which the cookie is valid. For example, `example.com` makes the cookie valid for that hostname and all subdomains.	`defaultDomain` is `false`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"defaultDomain","op":"eq","value":false}}
`path`	string (allows variables)	If the `defaultPath` is disabled, sets the path component for which the cookie is valid.	`defaultPath` is `false`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"defaultPath","op":"eq","value":false}}
`expires`	enum	Sets various ways to specify when the cookie expires.		{"displayType":"enum","options":["ON_BROWSER_CLOSE","FIXED_DATE","DURATION","NEVER"],"tag":"select"} {"if":{"attribute":"enabled","op":"eq","value":true}}
	`ON_BROWSER_CLOSE`	Limit the cookie to the duration of the session.
	`FIXED_DATE`	Requires a corresponding `expirationDate` field value.
	`DURATION`	Requires a corresponding `duration` field value.
	`NEVER`	Let the cookie persist indefinitely.
`expirationDate`	string (epoch timestamp)	If `expires` is set to `FIXED_DATE`, this sets when the cookie expires as a UTC date and time.	`expires` is `FIXED_DATE`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"expires","op":"eq","value":"FIXED_DATE"}}
`duration`	string (duration)	If `expires` is set to `DURATION`, this sets the cookie's lifetime.	`expires` is `DURATION`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"expires","op":"eq","value":"DURATION"}}
`sameSite`	enum	This option controls the `SameSite` cookie attribute that reduces the risk of cross-site request forgery attacks.		{"displayType":"enum","options":["DEFAULT","NONE","LAX","STRICT"],"tag":"select"} {"if":{"attribute":"enabled","op":"eq","value":true}}
	`DEFAULT`	Send the `SameSite` cookie attribute.
	`NONE`	Send the cookie in all contexts if the `secure` option is enabled.
	`LAX`	Send the cookie also when the user navigates to a URL from an external site.
	`STRICT`	Send the cookie only to the same site that originated it.
`secure`	boolean	When enabled, sets the cookie's `Secure` flag to transmit it with `HTTPS`.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`httpOnly`	boolean	When enabled, includes the `HttpOnly` attribute in the `Set-Cookie` response header to mitigate the risk of client-side scripts accessing the protected cookie, if the browser supports it.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}