Skip to content

Opensearch dashboards.sessionstoragecookieoptions

Home > opensearch-dashboards > SessionStorageCookieOptions

SessionStorageCookieOptions interface

Configuration used to create HTTP session storage based on top of cookie mechanism.

Signature:

export interface SessionStorageCookieOptions<T> 

Properties

Property Type Description
encryptionKey string A key used to encrypt a cookie's value. Should be at least 32 characters long.
isSecure boolean Flag indicating whether the cookie should be sent only via a secure connection.
name string Name of the session cookie.
sameSite? 'Strict' | 'Lax' | 'None' (Optional) Defines SameSite attribute of the Set-Cookie Header. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite
validate (sessionValue: T | T[]) => SessionCookieValidationResult Function called to validate a cookie's decrypted value.