HttpCookiePersistenceProfile

HttpCookiePersistenceProfile
HttpCookiePersistenceProfile
JSON Example
{
    "always_send_cookie": false,
    "cookie_name": "string",
    "encryption_key": "string",
    "http_only": false,
    "is_persistent_cookie": false,
    "key": [
        {
            "aes_key": "string",
            "hmac_key": "string",
            "name": "string"
        }
    ],
    "timeout": 0
}
boolean
always_send_cookie
Optional

If no persistence cookie was received from the client, always send it. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
cookie_name
Optional

HTTP cookie name for cookie persistence. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
encryption_key
Optional

Key name to use for cookie encryption. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
http_only
Optional

Sets the HttpOnly attribute in the cookie. Setting this helps to prevent the client side scripts from accessing this cookie, if supported by browser. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
is_persistent_cookie
Optional

When True, the cookie used is a persistent cookie, i.e. the cookie shouldn't be used at the end of the timeout. By default, it is set to false, making the cookie a session cookie, which allows clients to use it even after the timeout, if the session is still open. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

key
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As int32 As int32
timeout
Optional

The maximum lifetime of any session cookie. No value or 'zero' indicates no timeout. Allowed values are 1-14400. Special values are 0- No Timeout. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.