---
title: SetCustomCookie
description: Resource path:
component: pingam
version: 7.2
page_id: pingam:entity-reference:sec-amster-entity-setcustomcookie
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-setcustomcookie.html
llms_txt: https://docs.pingidentity.com/pingam/llms.txt
docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md
superseded_by: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-setcustomcookie.html
section_ids:
  sec-amster-entity-setcustomcookie-realm-ops: Realm Operations
  sec-amster-entity-setcustomcookie-realm-ops-create: create
  sec-amster-entity-setcustomcookie-realm-ops-delete: delete
  sec-amster-entity-setcustomcookie-realm-ops-getalltypes: getAllTypes
  sec-amster-entity-setcustomcookie-realm-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-setcustomcookie-realm-ops-listoutcomes: listOutcomes
  sec-amster-entity-setcustomcookie-realm-ops-nextdescendents: nextdescendents
  sec-amster-entity-setcustomcookie-realm-ops-query: query
  sec-amster-entity-setcustomcookie-realm-ops-read: read
  sec-amster-entity-setcustomcookie-realm-ops-update: update
---

# SetCustomCookie

## Realm Operations

Resource path:

```
/realm-config/authentication/authenticationtrees/nodes/SetCustomCookieNode
```

Resource version: `1.0`

### create

**Usage**

```
am> create SetCustomCookie --realm Realm --id id --body body
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "useSecureCookie" : {
        "title" : "Use Secure Cookie",
        "description" : "Sets the custom cookie as \"Secure\".",
        "propertyOrder" : 600,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "value" : {
        "title" : "Custom Cookie Value",
        "description" : "Sets the value of the custom cookie.",
        "propertyOrder" : 200,
        "type" : "string",
        "exampleValue" : ""
      },
      "domain" : {
        "title" : "Custom Cookie Domain",
        "description" : "Sets the domain of the custom cookie.",
        "propertyOrder" : 400,
        "type" : "string",
        "exampleValue" : ""
      },
      "path" : {
        "title" : "Custom Cookie Path",
        "description" : "Sets the path of the custom cookie.",
        "propertyOrder" : 500,
        "type" : "string",
        "exampleValue" : ""
      },
      "name" : {
        "title" : "Custom Cookie Name",
        "description" : "Sets the name of the custom cookie.",
        "propertyOrder" : 100,
        "type" : "string",
        "exampleValue" : ""
      },
      "useHttpOnlyCookie" : {
        "title" : "Use HTTP Only Cookie",
        "description" : "Sets the custom cookie as \"HttpOnly\".",
        "propertyOrder" : 700,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "maxAge" : {
        "title" : "Max Age",
        "description" : "The maximum length of time the custom cookie is valid for, in seconds. Both the Max Age and Expires attribute of the cookie are set behind the scenes for compatibility purposes.",
        "propertyOrder" : 300,
        "type" : "integer",
        "exampleValue" : ""
      },
      "sameSite" : {
        "title" : "Custom Cookie SameSite attribute",
        "description" : "Sets the same site attribute of the custom cookie.",
        "propertyOrder" : 800,
        "type" : "string",
        "exampleValue" : ""
      }
    },
    "required" : [ "sameSite", "value", "useHttpOnlyCookie", "useSecureCookie", "name" ]
  }
  ```

### delete

**Usage**

```
am> delete SetCustomCookie --realm Realm --id id
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

### getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

**Usage**

```
am> action SetCustomCookie --realm Realm --actionName getAllTypes
```

### getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

**Usage**

```
am> action SetCustomCookie --realm Realm --actionName getCreatableTypes
```

### listOutcomes

List the available outcomes for the node type.

**Usage**

```
am> action SetCustomCookie --realm Realm --body body --actionName listOutcomes
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "title" : "Some configuration of the node. This does not need to be complete against the configuration schema."
  }
  ```

### nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

**Usage**

```
am> action SetCustomCookie --realm Realm --actionName nextdescendents
```

### query

Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.

**Usage**

```
am> query SetCustomCookie --realm Realm --filter filter
```

**Parameters**

* *\--filter*

  A CREST formatted query filter, where "true" will query all.

### read

**Usage**

```
am> read SetCustomCookie --realm Realm --id id
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update SetCustomCookie --realm Realm --id id --body body
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "useSecureCookie" : {
        "title" : "Use Secure Cookie",
        "description" : "Sets the custom cookie as \"Secure\".",
        "propertyOrder" : 600,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "value" : {
        "title" : "Custom Cookie Value",
        "description" : "Sets the value of the custom cookie.",
        "propertyOrder" : 200,
        "type" : "string",
        "exampleValue" : ""
      },
      "domain" : {
        "title" : "Custom Cookie Domain",
        "description" : "Sets the domain of the custom cookie.",
        "propertyOrder" : 400,
        "type" : "string",
        "exampleValue" : ""
      },
      "path" : {
        "title" : "Custom Cookie Path",
        "description" : "Sets the path of the custom cookie.",
        "propertyOrder" : 500,
        "type" : "string",
        "exampleValue" : ""
      },
      "name" : {
        "title" : "Custom Cookie Name",
        "description" : "Sets the name of the custom cookie.",
        "propertyOrder" : 100,
        "type" : "string",
        "exampleValue" : ""
      },
      "useHttpOnlyCookie" : {
        "title" : "Use HTTP Only Cookie",
        "description" : "Sets the custom cookie as \"HttpOnly\".",
        "propertyOrder" : 700,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "maxAge" : {
        "title" : "Max Age",
        "description" : "The maximum length of time the custom cookie is valid for, in seconds. Both the Max Age and Expires attribute of the cookie are set behind the scenes for compatibility purposes.",
        "propertyOrder" : 300,
        "type" : "integer",
        "exampleValue" : ""
      },
      "sameSite" : {
        "title" : "Custom Cookie SameSite attribute",
        "description" : "Sets the same site attribute of the custom cookie.",
        "propertyOrder" : 800,
        "type" : "string",
        "exampleValue" : ""
      }
    },
    "required" : [ "sameSite", "value", "useHttpOnlyCookie", "useSecureCookie", "name" ]
  }
  ```