--- title: Set Custom Cookie node description: Configure the Set Custom Cookie node to store a custom cookie on the client during an PingAM authentication journey, including in no-session journeys. component: platform version: 7.5 page_id: platform:auth-node-ref:set-custom-cookie canonical_url: https://docs.pingidentity.com/platform/7.5/auth-node-ref/set-custom-cookie.html llms_txt: https://docs.pingidentity.com/platform/llms.txt docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md keywords: ["Nodes & Trees", "Journeys", "Authentication", "Scripts"] page_aliases: ["auth-node-set-custom-cookie.adoc"] section_ids: availability: Availability inputs: Inputs dependencies: Dependencies configuration: Configuration outcomes: Outcomes example: Example --- # Set Custom Cookie node The Set Custom Cookie node lets you store a custom cookie on the client in addition to the session cookie. The node uses the specified properties to create a cookie with a custom name and value. It can also set attributes, such as the cookie path, domain, expiry, and security flags. Use this node with the [Configuration Provider node](config-provider.html) to extend custom capabilities. For example, create a `Config Provider` script to set custom static values or access values from the shared node state. Include all the attributes in the configuration provider script's `config` map. The following example sets the attributes of the custom cookie to static values: ```javascript config = { "name": "testname", "value": "testvalue", "maxAge": "60", "domain": "am.example.com", "path": "/", "useSecureCookie": false, "useHttpOnlyCookie": false, "sameSite": "LAX" }; ``` Reference the script when you create a [Configuration Provider node](config-provider.html), and set the Node Type to `Set Custom Cookie`: ![Configuration Provider node referencing this node](_images/node-set-custom-cookie-config-provider.png) ## Availability | Product | Available? | | ------------------------------------- | ---------- | | PingOne Advanced Identity Cloud | Yes | | PingAM (self-managed) | Yes | | Ping Identity Platform (self-managed) | Yes | ## Inputs This node reads the user data from the shared node state. It requires a predecessor node that gathers the user data. ## Dependencies Make sure the user can successfully authenticate and get a session. If the `noSession` query parameter is used during authentication, the journey will fail. ## Configuration | Property | Usage | | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Custom Cookie Name *(required)* | The name of the custom cookie.The cookie name can contain any US-ASCII characters except for: space, tab, control, or a separator character (`()<>@,;:"/[]?=\{}`). | | Custom Cookie Value *(required)* | The value of the custom cookie. | | Max Age | The length of time the custom cookie remains valid, in seconds. If that time is exceeded, the cookie is no longer valid.AM sets the `Max-Age` and `Expires` attributes in the cookie to increase compatibility with different browsers.If omitted, the cookie expires at the end of the current session. The precise implementation of this is determined by the specific browser. Refer to [RFC 6265](https://www.rfc-editor.org/rfc/rfc6265#section-4.1.2.2) for details. | | Custom Cookie Domain | The domain the custom cookie will be sent to. If you specify a value here, AM sets a domain cookie. For example, if you set this property to `am.example.com`, AM sets a cookie on `.am.example.com`. Note the leading `.` indicating a domain cookie rather than a host cookie.If you don't set a value here, AM sets a host level cookie on the FQDN on which the client accessed AM. For example, if the client accesses AM at `https://am.example.com` and this property is empty, AM sets a host cookie on `am.example.com`. | | Custom Cookie Path | The path of the custom cookie. | | Use Secure Cookie | When enabled, adds the `Secure` flag to the custom cookie.If you include the `Secure` flag, the cookie can only be transferred over HTTPS. When a request is made over HTTP, the cookie isn't made available to the application. | | Use HTTP Only Cookie | When enabled, adds the `HttpOnly` flag to the custom cookie.If you include the `HttpOnly` flag, the cookie isn't accessible to scripts. | | Custom Cookie SameSite attribute | Sets the `SameSite` attribute of the custom cookie.The default value is `LAX`, to align with most modern browsers.Learn more in [SameSite cookie rules](https://docs.pingidentity.com/pingam/7.5/security/enable-samesite-cookies.html). | ## Outcomes Single outcome path. The cookie is created when AM next returns to the client. ## Example This example uses this node in a login flow. The node sets the custom cookie in the client browser after the user has successfully authenticated: ![The Set Custom Cookie node in context](_images/trees-node-set-custom-cookie-platform.png)